Skip to content

Commit e2b3e4e

Browse files
ronagcodebytere
authored andcommitted
doc: update collaborator guide citgm instructions
PR-URL: #31549 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Beth Griggs <[email protected]>
1 parent c167ae0 commit e2b3e4e

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

COLLABORATOR_GUIDE.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* [Waiting for Approvals](#waiting-for-approvals)
1414
* [Testing and CI](#testing-and-ci)
1515
* [Useful CI Jobs](#useful-ci-jobs)
16+
* [Starting a CI Job](#starting-a-ci-job)
1617
* [Internal vs. Public API](#internal-vs-public-api)
1718
* [Breaking Changes](#breaking-changes)
1819
* [Breaking Changes and Deprecations](#breaking-changes-and-deprecations)
@@ -191,12 +192,6 @@ everything else. Start a fresh CI if more than seven days have elapsed since
191192
the original failing CI as the compiled binaries for the Windows and ARM
192193
platforms are only kept for seven days.
193194

194-
Some of the CI Jobs may require `GIT_REMOTE_REF` which is the remote portion
195-
of Git refspec. To specify the branch this way `refs/heads/BRANCH` is used
196-
(i.e for `master` -> `refs/heads/master`).
197-
For pull requests it will look like `refs/pull/PR_NUMBER/head`
198-
(i.e. for PR#42 -> `refs/pull/42/head`).
199-
200195
#### Useful CI Jobs
201196

202197
* [`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/)
@@ -222,6 +217,31 @@ not used in other CI test runs (such as tests in the `internet` or `pummel`
222217
directories). It can also make sure tests pass when provided with a flag not
223218
used in other CI test runs (such as `--worker`).
224219

220+
#### Starting a CI Job
221+
222+
From the CI Job page, click "Build with Parameters" on the left side.
223+
224+
You generally need to enter only one or both of the following options
225+
in the form:
226+
227+
* `GIT_REMOTE_REF`: Change to the remote portion of git refspec.
228+
To specify the branch this way, `refs/heads/BRANCH` is used
229+
(e.g. for `master` -> `refs/heads/master`).
230+
For pull requests, it will look like `refs/pull/PR_NUMBER/head`
231+
(e.g. for PR#42 -> `refs/pull/42/head`).
232+
* `REBASE_ONTO`: Change that to `origin/master` so the pull request gets rebased
233+
onto master. This can especially be important for pull requests that have been
234+
open a while.
235+
236+
Look at the list of jobs on the left hand side under "Build History" and copy
237+
the link to the one you started (which will be the one on top, but click
238+
through to make sure it says something like "Started 5 seconds ago"
239+
(top right) and "Started by user ...".
240+
241+
Copy/paste the URL for the job into a comment in the pull request.
242+
[`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/)
243+
is an exception where the GitHub bot will automatically post for you.
244+
225245
### Internal vs. Public API
226246

227247
All functionality in the official Node.js documentation is part of the public

0 commit comments

Comments
 (0)