GeezerVison is showing github.com — doc: recommend node-stress-single-test for flaky tests · nodejs/node@05eae28
File tree
Expand file treeCollapse file tree
Open diff view settings
Expand file treeCollapse file tree
Open diff view settings
Collapse file
Copy file name to clipboardExpand all lines: doc/contributing/collaborator-guide.md +1-1Lines changed: 1 addition & 1 deletion - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -296,7 +296,7 @@ label to the pull request. |
296 | 296 |
|
297 | 297 | * [`node-stress-single-test`](https://ci.nodejs.org/job/node-stress-single-test/) |
298 | 298 | can run a group of tests over and over on a specific platform. Use it to check |
299 | | - that the tests are reliable. |
| 299 | + that the tests are reliable (i.e. not flaky). |
300 | 300 |
|
301 | 301 | * [`node-test-commit-v8-linux`](https://ci.nodejs.org/job/node-test-commit-v8-linux/) |
302 | 302 | runs the standard V8 tests. Run it when updating V8 in Node.js or floating new |
|
Collapse file
Copy file name to clipboardExpand all lines: onboarding.md +5-1Lines changed: 5 additions & 1 deletion - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -286,7 +286,10 @@ needs to be pointed out separately during the onboarding. |
286 | 286 | * If you are interested in helping to fix coverity reports consider requesting |
287 | 287 | access to the projects coverity project as outlined in [static-analysis][]. |
288 | 288 | * If you are interested in helping out with CI reliability, check out the |
289 | | - [reliability repository][] and [guide on how to deal with CI flakes][]. |
| 289 | + [reliability repository][] and [guide on how to deal with CI flakes][]. When |
| 290 | + fixing a flaky test, it is recommended to run [`node-stress-single-test`][] |
| 291 | + on both the main branch and the test branch to verify the fix makes the test |
| 292 | + more stable under repeated runs. |
290 | 293 |
|
291 | 294 | [Code of Conduct]: https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md |
292 | 295 | [Labels]: doc/contributing/collaborator-guide.md#labels |
@@ -296,6 +299,7 @@ needs to be pointed out separately during the onboarding. |
296 | 299 | [`author-ready`]: doc/contributing/collaborator-guide.md#author-ready-pull-requests |
297 | 300 | [`core-validate-commit`]: https://github.com/nodejs/core-validate-commit |
298 | 301 | [`git-node`]: https://github.com/nodejs/node-core-utils/blob/HEAD/docs/git-node.md |
| 302 | +[`node-stress-single-test`]: https://ci.nodejs.org/job/node-stress-single-test/ |
299 | 303 | [`node-test-pull-request`]: https://ci.nodejs.org/job/node-test-pull-request/ |
300 | 304 | [guide on how to deal with CI flakes]: https://github.com/nodejs/test?tab=readme-ov-file#protocols-in-improving-ci-reliability |
301 | 305 | [participants' expenses]: https://github.com/openjs-foundation/cross-project-council/blob/main/community-fund/COMMUNITY_FUND_POLICY.md#community-fund-rules |
|