-
-
Notifications
You must be signed in to change notification settings - Fork 34k
build: ignore changes in docs #55954
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.
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
Conversation
|
Review requested:
|
richardlau
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have tests that check the docs for consistency, e.g.
node/test/parallel/test-cli-node-options-docs.js
Lines 13 to 14 in 3178a76
| const cliMd = path.join(rootDir, 'doc', 'api', 'cli.md'); | |
| const cliText = fs.readFileSync(cliMd, { encoding: 'utf8' }); |
021ae08 to
319af94
Compare
|
This test ensures that all CLI options are documented but does not validate other parts of the documentation. I put |
There are others, e.g.
|
|
The addons tests also extract the code snippets from the documentation to test those: Lines 369 to 387 in 3178a76
|
|
This case I will close the PR, sorry about my English (It's in progress). |
When only documentation is changed, running tests may not be necessary. Perhaps we could consider skipping them in such cases.