Skip to content

Commit

Permalink
fixup! doc: update CI requirements for landing pull requests
Browse files Browse the repository at this point in the history
  • Loading branch information
aduh95 committed Feb 10, 2021
1 parent 8725272 commit 50a2af3
Showing 1 changed file with 35 additions and 10 deletions.
45 changes: 35 additions & 10 deletions doc/guides/collaborator-guide.md
Expand Up @@ -209,22 +209,47 @@ the comment anyway to avoid any doubt.
All fixes must have a test case which demonstrates the defect. The test should
fail before the change, and pass after the change.

All pull requests must pass continuous integration tests. Code changes must pass
on [project CI server](). Pull requests that only change
documentation and comments can use GitHub Actions results.

Do not land any pull requests without a passing (green or yellow) CI run.
A green GitHub Actions CI result is required. A passing
[Jenkins CI](https://ci.nodejs.org/) is also required if PR contains changes
on files in one of the following folders (except it only changes comments):
- `deps/`
- `lib/`
- `src/`
- `test/`
that will affect the `node` binary. This is critical as GitHub Actions CI does
not cover all the environments supported by Node.js.

<details>
<summary>Changes that affect the `node` binary</summary>

Changes in the following folders (except comment-only changes) are guaranteed to
affect the `node` binary:

* `deps/`
* `lib/`
* `src/`
* `test/`
* `tools/code_cache/`
* `tools/gyp/`
* `tools/icu/`
* `tools/inspector-protocol/`
* `tools/msvs/`
* `tools/snapshot/`
* `tools/v8_gypfiles/`

There are some other files that touch the build chain. Changes in the following
files also qualify as affecting the `node` binary:

* `tools/*.py`
* `tools/build-addons.js`
* `*.gyp`
* `*.gypi`
* `configure`
* `configure.py`
* `Makefile`
* `vcbuilt.bat`

</details>

If there are GitHub Actions CI failures unrelated to the change in the pull
request, try "Re-run all jobs". It's under the "🔄 Re-run jobs" button, on the
right-hand side of "Checks" tab.
right-hand side of "Checks" tab.

If there are Jenkins CI failures unrelated to the change in the pull request,
try "Resume Build". It is in the left navigation of the relevant
Expand Down

0 comments on commit 50a2af3

Please sign in to comment.