Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update collaborator guide with citgm instructions #31549

Closed
wants to merge 6 commits into from
Closed

docs: update collaborator guide with citgm instructions #31549

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
300fe21
docs: update collaborator guide with citgm instructions
ronag Jan 28, 2020
45dd15f
fixup
ronag Jan 28, 2020
202a183
fixup
ronag Jan 28, 2020
519a4b2
fixup: TOC
ronag Jan 28, 2020
e044298
Update COLLABORATOR_GUIDE.md
ronag Jan 30, 2020
4c9502b
Apply suggestions from code review
ronag Jan 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 26 additions & 6 deletions COLLABORATOR_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
* [Waiting for Approvals](#waiting-for-approvals)
* [Testing and CI](#testing-and-ci)
* [Useful CI Jobs](#useful-ci-jobs)
* [Starting a CI Job](#starting-a-ci-job)
* [Internal vs. Public API](#internal-vs-public-api)
* [Breaking Changes](#breaking-changes)
* [Breaking Changes and Deprecations](#breaking-changes-and-deprecations)
Expand Down Expand Up @@ -191,12 +192,6 @@ everything else. Start a fresh CI if more than seven days have elapsed since
the original failing CI as the compiled binaries for the Windows and ARM
platforms are only kept for seven days.

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

#### Useful CI Jobs

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

#### Starting a CI Job

From the CI Job page, click "Build with Parameters" on the left side.

You generally need to enter only one or both of the following options
in the form:

* `GIT_REMOTE_REF`: Change to the remote portion of Git refspec.
ronag marked this conversation as resolved.
Show resolved Hide resolved
To specify the branch this way `refs/heads/BRANCH` is used
ronag marked this conversation as resolved.
Show resolved Hide resolved
(i.e for `master` -> `refs/heads/master`).
ronag marked this conversation as resolved.
Show resolved Hide resolved
For pull requests it will look like `refs/pull/PR_NUMBER/head`
ronag marked this conversation as resolved.
Show resolved Hide resolved
(i.e. for PR#42 -> `refs/pull/42/head`).
ronag marked this conversation as resolved.
Show resolved Hide resolved
* `REBASE_ONTO`: Change that to origin/master so the pull request gets rebased
ronag marked this conversation as resolved.
Show resolved Hide resolved
onto master. This can especially be important for pull requests that have been
open a while.

Look at the list of jobs on the left hand side under "Build History" and copy
the link to the one you started (which will be the one on top, but click
through to make sure it says something like "Started 5 seconds ago"
(top right) and "Started by user ...".

Copy/paste the URL for the job into a comment in the pull request.
[`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/)
is an exception where the GitHub bot will automatically post for you.

### Internal vs. Public API

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