Skip to content

doc: recommend node-stress-single-test for flaky tests #64223

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

Open
trivikr wants to merge 3 commits into
base: main
Choose a base branch
from
+5 −2
Open

doc: recommend node-stress-single-test for flaky tests #64223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ef9208e
doc: recommend node-stress-single-test for flaky tests
trivikr Jul 1, 2026
0e538ec
fixup! doc: state "not flaky" in brackets
trivikr Jul 1, 2026
595d1ff
fixup! doc: recommend running stress test in main too
trivikr Jul 1, 2026
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
2 changes: 1 addition & 1 deletion doc/contributing/collaborator-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ label to the pull request.

* [`node-stress-single-test`](https://ci.nodejs.org/job/node-stress-single-test/)
can run a group of tests over and over on a specific platform. Use it to check
that the tests are reliable.
that the tests are reliable (i.e. not flaky).

* [`node-test-commit-v8-linux`](https://ci.nodejs.org/job/node-test-commit-v8-linux/)
runs the standard V8 tests. Run it when updating V8 in Node.js or floating new
Expand Down
5 changes: 4 additions & 1 deletion onboarding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,9 @@ needs to be pointed out separately during the onboarding.
* If you are interested in helping to fix coverity reports consider requesting
access to the projects coverity project as outlined in [static-analysis][].
* If you are interested in helping out with CI reliability, check out the
[reliability repository][] and [guide on how to deal with CI flakes][].
[reliability repository][] and [guide on how to deal with CI flakes][]. When
fixing a flaky test, it is recommended to run [`node-stress-single-test`][]

@sxa sxa Jul 1, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
fixing a flaky test, it is recommended to run [`node-stress-single-test`][]
fixing a flaky test, it is recommended to run [`node-stress-single-test`][https://ci.nodejs.org/job/node-stress-single-test]

@trivikr trivikr Jul 1, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mentioning the hyperlink in the bottom improves the source code readability, right?

It's done twice on line 289 for example.

[reliability repository][] and [guide on how to deal with CI flakes][].

on both the main branch and the test branch to verify the fix makes the test more stable under repeated runs.

[Code of Conduct]: https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md
[Labels]: doc/contributing/collaborator-guide.md#labels
Expand All @@ -296,6 +298,7 @@ needs to be pointed out separately during the onboarding.
[`author-ready`]: doc/contributing/collaborator-guide.md#author-ready-pull-requests
[`core-validate-commit`]: https://github.com/nodejs/core-validate-commit
[`git-node`]: https://github.com/nodejs/node-core-utils/blob/HEAD/docs/git-node.md
[`node-stress-single-test`]: https://ci.nodejs.org/job/node-stress-single-test/
[`node-test-pull-request`]: https://ci.nodejs.org/job/node-test-pull-request/
[guide on how to deal with CI flakes]: https://github.com/nodejs/test?tab=readme-ov-file#protocols-in-improving-ci-reliability
[participants' expenses]: https://github.com/openjs-foundation/cross-project-council/blob/main/community-fund/COMMUNITY_FUND_POLICY.md#community-fund-rules
Expand Down
Loading