You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Running make doc (and making sure the exit status is 0) can help with nodejs/node#15447. I think the chances a YAML error would be introduced are low, but it would be great to catch this via CI as an early warning system, and not via checking the nightly doc builds :)
IMHO this should be done in code, as a test in /test/sequential so that we could not only check sanity, but also validate properties of the resulted docs.
Meanwhile I see no harm in adding make doc-only to node-test-linter
Looks like this happened again (see nodejs/node#14930 (comment) for details). Personally, I still think compiling docs via node-test-commit (or node-test-linter) is the best solution. I see @gibfahn and @mhdawson gave a +1 to @refack's comment above... what's the best way to move forward here?
IMHO this should be done in code, as a test in /test/sequential so that we could not only check sanity, but also validate properties of the resulted docs.
that would just be a PR to nodejs/node that added a test in test/sequential/ that runs make doc and verifies that things work okay.
Activity
vsemozhetbyt commentedon Sep 17, 2017
Refs: nodejs/node#14930 (2 cases)
refack commentedon Sep 17, 2017
@maclover7 thanks for following up on this.
/test/sequentialso that we could not only check sanity, but also validate properties of the resulted docs.make doc-onlytonode-test-lintermaclover7 commentedon Oct 6, 2017
Looks like this happened again (see nodejs/node#14930 (comment) for details). Personally, I still think compiling docs via node-test-commit (or node-test-linter) is the best solution. I see @gibfahn and @mhdawson gave a +1 to @refack's comment above... what's the best way to move forward here?
gibfahn commentedon Oct 6, 2017
So assuming we're doing this:
that would just be a PR to nodejs/node that added a test in
test/sequential/that runsmake docand verifies that things work okay.test: test make doc and verify toc
test: add common.projectDir
test: test make doc and verify toc
test: add common.projectDir
test: test make doc and verify toc
test: test make doc and verify toc
test: add common.projectDir
test: add common.projectDir