Skip to content

Commit ab4375e

Browse files
committed
[docs] Update new builder instructions to default to building each change
We generally prefer build bots which build each change as they come in as long as they can keep up. This generates much higher quality feedback to a developer. However, the code structure is such that we currently default new builders to batching. This change updates the getting started instruction for a builder to explicitly advocate for not collapsing requests. Differential Revision: https://reviews.llvm.org/D112776
1 parent 29c31cb commit ab4375e

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

llvm/docs/HowToAddABuilder.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,14 @@ Here are the steps you can follow to do so:
121121
Please make sure your builder name and its builddir are unique through the
122122
file.
123123

124+
All new builders should default to using the "'collapseRequests': False"
125+
configuration. This causes the builder to build each commit individually
126+
and not merge build requests. To maximize quality of feedback to developers,
127+
we *strongly prefer* builders to be configured not to collapse requests.
128+
This flag should be removed only after all reasonable efforts have been
129+
exhausted to improve build times such that the builder can keep up with
130+
commit flow.
131+
124132
It is possible to allow email addresses to unconditionally receive
125133
notifications on build failure; for this you'll need to add an
126134
``InformativeMailNotifier`` to ``buildbot/osuosl/master/config/status.py``.

0 commit comments

Comments
 (0)