fix(hooks): surface gitleaks finding and clear block message#9
Merged
Conversation
The global pre-commit hook scanned with no -v and aborted via a bare exit 1, so a blocked commit showed only 'leaks found: N' with no rule/file/line or remedy. Add -v to print the finding and an explicit COMMIT BLOCKED message with fix/override guidance, and --log-level error so clean commits stay silent.
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.
Summary
Improve the global pre-commit hook's UX when it blocks a secret commit. Previously it ran
gitleaks protect --staged --no-banner --redactwith no-vand aborted via a bare|| exit 1, so the user saw onlyleaks found: Nwith no rule/file/line and no remedy.Now the secret-scan block:
-vso a hit prints the finding (RuleID/File/Line)--log-level errorso clean commits stay fully silentexit 1with an explicit COMMIT BLOCKED message including fix and override guidanceOnly
dotfiles/git/hooks/pre-commitchanges; bootstrap already deploys it viacp -Rto~/.config/git/hooks.Why
A guard that just prints a count and stops is frustrating and unteachable. Showing what/where and how to fix turns it into an actionable, educational block.
Test plan
Tested directly (no real commit needed):
RuleID: private-key/File/Line+ COMMIT BLOCKED, exit 1.shellcheckclean.Out of scope (deferred)
gitleaks protect --stagedtogitleaks git --staged(deprecated in 8.18+, still works in 8.30.1).