-
Notifications
You must be signed in to change notification settings - Fork 305
Chore: Make installing the pre-commit hook "required" #2295
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
Open
mdboom
wants to merge
1
commit into
NVIDIA:main
Choose a base branch
from
mdboom:pre-commit-stronger
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
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
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nice, thanks. |
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,62 @@ | ||
| # SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| """Warn (without failing) if the pre-commit git hook is not installed. | ||
|
|
||
| This repo relies on pre-commit running on *every* commit: the SPDX header | ||
| updater and the .pyi stub generator only keep the tree consistent if they | ||
| run automatically via the installed git hook. Contributors who only run | ||
| `pre-commit run --all-files` manually (or never run pre-commit at all) can | ||
| end up with stale headers or stubs. This check can't block the commit | ||
| (if pre-commit isn't installed as a git hook, this script never runs | ||
| during `git commit` in the first place) but it does fire during manual | ||
| `pre-commit run` invocations and in CI, where it gives contributors a | ||
| visible nudge to run `pre-commit install`. | ||
| """ | ||
|
|
||
| import subprocess | ||
| import sys | ||
|
|
||
| MARKER = b"File generated by pre-commit" | ||
|
|
||
|
|
||
| def _git_hooks_dir() -> str: | ||
| result = subprocess.run( | ||
| ["git", "rev-parse", "--git-path", "hooks"], # noqa: S607 | ||
| capture_output=True, | ||
| check=True, | ||
| text=True, | ||
| ) | ||
| return result.stdout.strip() | ||
|
|
||
|
|
||
| def main() -> int: | ||
| hooks_dir = _git_hooks_dir() | ||
| hook_path = f"{hooks_dir}/pre-commit" | ||
|
|
||
| try: | ||
| with open(hook_path, "rb") as f: | ||
| installed = MARKER in f.read() | ||
| except FileNotFoundError: | ||
| installed = False | ||
|
|
||
| if not installed: | ||
| print( | ||
| "\n" | ||
| "==================== pre-commit WARNING ====================\n" | ||
| "The pre-commit git hook is not installed in this checkout.\n" | ||
| "Without it, checks only run when you invoke pre-commit\n" | ||
| "manually, and will NOT run automatically on `git commit`.\n" | ||
| "\n" | ||
| "Fix this by running:\n" | ||
| "\n" | ||
| " pre-commit install\n" | ||
| "==============================================================\n", | ||
| file=sys.stderr, | ||
| ) | ||
|
|
||
| return 0 | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| sys.exit(main()) |
Oops, something went wrong.
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.
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.
Non-blocking: I thought
pre-commit -abelow would take care of this step?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.
It only takes care of it if you remember to run it before every single commit.
The driver for this change is that some people forget to run it with every commit (easy to do), and CI only checks the last commit. Most of the time, that's equivalent, but with copyright year handling (which needs to know what changed) and
.pyihandling (which can introduce conflicts) it isn't equivalent.