Commit d935fef
doc: consolidate CI sections
PR-URL: #42534
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Tierney Cyren <hello@bnb.im>1 parent a1fe0d2 commit d935fef
1 file changed
Lines changed: 11 additions & 21 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -27,7 +27,6 @@ | |||
| 27 | 27 | * [Notes](#notes) | |
| 28 | 28 | * [Commit squashing](#commit-squashing) | |
| 29 | 29 | * [Getting approvals for your pull request](#getting-approvals-for-your-pull-request) | |
| 30 | - * [CI testing](#ci-testing) | ||
| 31 | 30 | * [Waiting until the pull request gets landed](#waiting-until-the-pull-request-gets-landed) | |
| 32 | 31 | * [Check out the collaborator guide](#check-out-the-collaborator-guide) | |
| 33 | 32 | * [Appendix: subsystems](#appendix-subsystems) | |
@@ -511,17 +510,18 @@ feedback. | |||
| 511 | 510 | All pull requests that contain changes to code must be run through | |
| 512 | 511 | continuous integration (CI) testing at [https://ci.nodejs.org/][]. | |
| 513 | 512 | ||
| 514 | - Only Node.js core collaborators with commit rights to the `nodejs/node` | ||
| 515 | - repository may start a CI testing run. The specific details of how to do | ||
| 516 | - this are included in the new collaborator [Onboarding guide][]. | ||
| 513 | + Only Node.js core collaborators and triagers can start a CI testing run. The | ||
| 514 | + specific details of how to do this are included in the new collaborator | ||
| 515 | + [Onboarding guide][]. Usually, a collaborator or triager will start a CI | ||
| 516 | + test run for you as approvals for the pull request come in. | ||
| 517 | + If not, you can ask a collaborator or triager to start a CI run. | ||
| 517 | 518 | ||
| 518 | 519 | Ideally, the code change will pass ("be green") on all platform configurations | |
| 519 | - supported by Node.js (there are over 30 platform configurations currently). | ||
| 520 | - This means that all tests pass and there are no linting errors. In reality, | ||
| 521 | - however, it is not uncommon for the CI infrastructure itself to fail on | ||
| 522 | - specific platforms or for so-called "flaky" tests to fail ("be red"). It is | ||
| 523 | - vital to visually inspect the results of all failed ("red") tests to determine | ||
| 524 | - whether the failure was caused by the changes in the pull request. | ||
| 520 | + supported by Node.js. This means that all tests pass and there are no linting | ||
| 521 | + errors. In reality, however, it is not uncommon for the CI infrastructure itself | ||
| 522 | + to fail on specific platforms or for so-called "flaky" tests to fail ("be red"). | ||
| 523 | + It is vital to visually inspect the results of all failed ("red") tests to | ||
| 524 | + determine whether the failure was caused by the changes in the pull request. | ||
| 525 | 525 | ||
| 526 | 526 | ## Notes | |
| 527 | 527 | ||
@@ -553,16 +553,6 @@ After you push new changes to your branch, you need to get | |||
| 553 | 553 | approval for these new changes again, even if GitHub shows "Approved" | |
| 554 | 554 | because the reviewers have hit the buttons before. | |
| 555 | 555 | ||
| 556 | - ### CI testing | ||
| 557 | - | ||
| 558 | - Every pull request needs to be tested | ||
| 559 | - to make sure that it works on the platforms that Node.js | ||
| 560 | - supports. This is done by running the code through the CI system. | ||
| 561 | - | ||
| 562 | - Only a collaborator can start a CI run. Usually one of them will do it | ||
| 563 | - for you as approvals for the pull request come in. | ||
| 564 | - If not, you can ask a collaborator to start a CI run. | ||
| 565 | - | ||
| 566 | 556 | ### Waiting until the pull request gets landed | |
| 567 | 557 | ||
| 568 | 558 | A pull request needs to stay open for at least 48 hours from when it is | |
@@ -591,7 +581,7 @@ You can find the full list of supported subsystems in the | |||
| 591 | 581 | More than one subsystem may be valid for any particular issue or pull request. | |
| 592 | 582 | ||
| 593 | 583 | [Building guide]: ../../BUILDING.md | |
| 594 | - [CI (Continuous Integration) test run]: #ci-testing | ||
| 584 | + [CI (Continuous Integration) test run]: #continuous-integration-testing | ||
| 595 | 585 | [Code of Conduct]: https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md | |
| 596 | 586 | [Onboarding guide]: ../../onboarding.md | |
| 597 | 587 | [approved]: #getting-approvals-for-your-pull-request | |
0 commit comments