Skip to content

Commit 6ec3bd5

Browse files
hoodmaneStanFromIrelandhugovk
authored
Add explanation to buildbots.rst about triggering buildbot on a PR (#1605)
Co-authored-by: Stan Ulbrych <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]>
1 parent 2fad851 commit 6ec3bd5

File tree

2 files changed

+42
-3
lines changed

2 files changed

+42
-3
lines changed

testing/buildbots.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,41 @@ after each commit. In particular, reference leaks builds take several hours to
4848
complete so they are done periodically. This is why it's important for you to
4949
be able to check the results yourself, too.
5050

51+
Triggering buildbots on a pull request
52+
======================================
53+
54+
To trigger buildbots on a pull request you need to be a CPython triager or a
55+
core team member. If you are not, ask someone to trigger them on your behalf.
56+
57+
The simplest way to trigger most buildbots on your PR is with the
58+
:gh-label:`🔨 test-with-buildbots` and :gh-label:`🔨 test-with-refleak-buildbots`
59+
labels. (See :ref:`github-pr-labels`.)
60+
61+
These will run buildbots on the most recent commit. If you want to trigger the
62+
buildbots again on a later commit, you'll have to remove the label and add it
63+
again.
64+
65+
If you want to test a pull request against specific platforms, you can trigger
66+
one or more build bots by posting a comment that begins with:
67+
68+
.. code-block:: none
69+
70+
!buildbot regex-matching-target
71+
72+
For example to run both the iOS and Android build bot, you can use:
73+
74+
.. code-block:: none
75+
76+
!buildbot ios|android
77+
78+
bedevere-bot will post a comment indicating which build bots, if
79+
any, were matched. If none were matched, or you do not have the
80+
necessary permissions to trigger a request, it will tell you that too.
81+
82+
The ``!buildbot`` comment will also only run buildbots on the most recent
83+
commit. To trigger the buildbots again on a later commit, you will have to
84+
repeat the comment.
85+
5186
Checking results of automatic builds
5287
====================================
5388

triage/labels.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,13 @@ to trigger specific bot behaviors.
158158
* :gh-label:`skip news <skip%20news>`: for PRs that don't need a NEWS entry.
159159
The :ref:`news-entry` section covers in details in which cases the NEWS entry
160160
can be skipped.
161-
* :gh-label:`🔨 test-with-buildbots <%3Ahammer%3A%20test-with-buildbots>`: used to test the latest commit with
162-
the :ref:`buildbot fleet <buildbots>` whenever more testing is required
163-
before merging. This may take multiple hours to complete.
161+
* :gh-label:`🔨 test-with-buildbots <%3Ahammer%3A%20test-with-buildbots>`: used
162+
to test the latest commit with the :ref:`buildbot fleet <buildbots>` whenever
163+
more testing is required before merging. This may take multiple hours to
164+
complete.
165+
* :gh-label:`🔨 test-with-refleak-buildbots <%3Ahammer%3A%20test-with-refleak-buildbots>`:
166+
Run the reference leak buildbots on the latest commit. Useful for when the
167+
code might be leaky.
164168
* :samp:`awaiting {action}`: these labels are applied and used by `bedevere`_
165169
to indicate the stage of a PR and should not be applied manually.
166170

0 commit comments

Comments
 (0)