Repository navigation
Run the Diff-Scoped Doc Gates in a Hook This Repository Actually Has #642
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| #!/bin/sh | ||
| # Local pre-commit gate for this repository: the doc checks CI runs, scoped to the diff. | ||
| # Enable it per clone with `git config core.hooksPath .husky`. | ||
| # A clone carries no hooks path, so this file does nothing until that is set. | ||
| # It deliberately does not source `_/husky.sh`. | ||
| # That file is gitignored and arrives with an npm install this repository does not have. | ||
| # Sourcing it would therefore break the hook in a fresh clone. | ||
| # The path is kept for the fleet convention the line-ending pins are written against. | ||
| # What is absent is a decision rather than an oversight. | ||
| # `repo_gate.py --check sha-pin` resolves same-owner pins against the GitHub API. | ||
| # It stays in CI, where a network is assumed, since a hook needing one fails offline. | ||
| # The doc linters that need Docker stay in CI and in the VS Code Lint tasks. | ||
| set -e | ||
|
|
||
| # Scoped to what changed against HEAD, which is the policy for prose. | ||
| # A rule is applied as a file is next edited rather than swept across the tree. | ||
| # Whole-tree costs about 2.2 seconds where this costs about 0.2. | ||
| # The scope is the working tree rather than the index. | ||
| # A partially staged file is therefore judged on all of its edits, not only the staged ones. | ||
| # CI re-runs the same rules over the whole tree, which is what makes that affordable here. | ||
| python3 scripts/prose_lint.py . --diff HEAD | ||
| python3 scripts/repo_gate.py --check eol |
This file contains hidden or 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 file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.