Update PreCommit.md with audit mode details #4280
Open
Conversation
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
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.
Description:
Some users new to adding the TH pre-commit hook want to test the hook without enforcement (meaning the commit won't be blocked by the presence of a secret). This
PreCommit.mdupdate instructs users to: (1) remove the--failflag, (2) pipestderrto/dev/nullso that the non-secret details aren't outputted to console. This effectively means the pre-commit hook will always pass, but any verified or unknown secrets will be outputted to console.I verified this works with global built-in git hooks, the pre-commit framework and husky.
The alternative would be to add an
--auditflag to the CLI. While a simple change, I think providing instructions on how to use the existing flags is sufficient given the user base for this feature isn't particularly huge.