Skip to content

Commit b2e6cbd

Browse files
TrottBethGriggs
authored andcommitted
doc: update Useful CI Jobs section of Collaborator Guide
Revise the Useful CI Jobs section of the Collaborator Guide to be more clear and concise. PR-URL: #24916 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
1 parent d760572 commit b2e6cbd

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

COLLABORATOR_GUIDE.md

+14-17
Original file line numberDiff line numberDiff line change
@@ -179,22 +179,21 @@ fail before the change, and pass after the change.
179179
All pull requests must pass continuous integration tests on the
180180
[project CI server](https://ci.nodejs.org/).
181181

182-
Do not land any Pull Requests without passing (green or yellow) CI runs. If
183-
there are CI failures unrelated to the change in the Pull Request, try "Resume
182+
Do not land any pull requests without passing (green or yellow) CI runs. If
183+
there are CI failures unrelated to the change in the pull request, try "Resume
184184
Build". It is in the left navigation of the relevant `node-test-pull-request`
185185
job. It will preserve all the green results from the current job but re-run
186186
everything else.
187187

188188
#### Useful CI Jobs
189189

190190
* [`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/)
191-
is the standard CI run we do to check Pull Requests. It triggers
192-
`node-test-commit`, which runs the `build-ci` and `test-ci` targets on all
193-
supported platforms.
191+
is the CI job to test pull requests. It runs the `build-ci` and `test-ci`
192+
targets on all supported platforms.
194193

195194
* [`node-test-pull-request-lite-pipeline`](https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/)
196-
only runs the linter job, as well as the tests on LinuxONE, which is very fast.
197-
This is useful for changes that only affect comments or documentation.
195+
runs the linter job. It also runs the tests on a very fast host. This is useful
196+
for changes that only affect comments or documentation.
198197

199198
* [`citgm-smoker`](https://ci.nodejs.org/job/citgm-smoker/)
200199
uses [`CitGM`](https://github.com/nodejs/citgm) to allow you to run
@@ -203,20 +202,18 @@ useful to check whether a change will cause breakage in the ecosystem. To test
203202
Node.js ABI changes you can run [`citgm-abi-smoker`](https://ci.nodejs.org/job/citgm-abi-smoker/).
204203

205204
* [`node-stress-single-test`](https://ci.nodejs.org/job/node-stress-single-test/)
206-
is designed to allow one to run a group of tests over and over on a specific
207-
platform to confirm that the test is reliable.
205+
can run a group of tests over and over on a specific platform. Use it to check
206+
that the tests are reliable.
208207

209208
* [`node-test-commit-v8-linux`](https://ci.nodejs.org/job/node-test-commit-v8-linux/)
210-
is designed to allow validation of changes to the copy of V8 in the Node.js
211-
tree by running the standard V8 tests. It should be run whenever the
212-
level of V8 within Node.js is updated or new patches are floated on V8.
209+
runs the standard V8 tests. Run it when updating V8 in Node.js or floating new
210+
patches on V8.
213211

214212
* [`node-test-commit-custom-suites`](https://ci.nodejs.org/job/node-test-commit-custom-suites/)
215-
can be used to customize what tests are run and with what parameters. For
216-
example, it can be used to execute tests which are not executed in a typical
217-
`node-test-commit` run (such as tests in the `internet` or `pummel`
218-
directories). It can also be used to make sure tests pass when provided with a
219-
flag not typically used in other CI test runs (such as `--worker`).
213+
enables customization of test suites and parameters. It can execute test suites
214+
not used in other CI test runs (such as tests in the `internet` or `pummel`
215+
directories). It can also make sure tests pass when provided with a flag not
216+
used in other CI test runs (such as `--worker`).
220217

221218
### Internal vs. Public API
222219

0 commit comments

Comments
 (0)