chore: ensure new-docs are up to date #5994
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds a Travis check that if we re-generate the docs we get the exact output (by checking if the Git tree is dirty). We do the dirty check by using `git status --porcelain`, seeing how many lines that outputs, and using that as the exit code (taking only the first 255 lines to avoid invalid exit codes). `--porcelain` makes the output be empty if the repo is not dirty in anyway which translates into an exit code of 0.
| @@ -33,7 +33,8 @@ | |||
| "update-protocol-d-ts": "node utils/protocol-types-generator update", | |||
| "compare-protocol-d-ts": "node utils/protocol-types-generator compare", | |||
| "test-install": "scripts/test-install.sh", | |||
| "generate-docs": "npm run tsc && api-extractor run --local --verbose && api-documenter markdown -i temp -o new-docs" | |||
| "generate-docs": "npm run tsc && api-extractor run --local --verbose && api-documenter markdown -i temp -o new-docs", | |||
| "ensure-new-docs-up-to-date": "npm run generate-docs && exit `git status --porcelain | head -255 | wc -l`" | |||
There was a problem hiding this comment.
Suggested change
| "ensure-new-docs-up-to-date": "npm run generate-docs && exit `git status --porcelain | head -255 | wc -l`" | |
| "ensure-new-docs-up-to-date": "npm run generate-docs && git diff-index --quiet HEAD" |
There was a problem hiding this comment.
This would be nicer, but doesn't error if there's an untracked file in the repo. e.g.:
// start with clean repo
touch foo.txt
git diff-index --quiet HEAD exits with 0
mathiasbynens
approved these changes
Jun 10, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a Travis check that if we re-generate the docs we get the
exact output (by checking if the Git tree is dirty).
We do the dirty check by using
git status --porcelain, seeing how manylines that outputs, and using that as the exit code (taking only the
first 255 lines to avoid invalid exit codes).
--porcelainmakes theoutput be empty if the repo is not dirty in anyway which translates into
an exit code of 0.