build: add commit-msg hook to enforce Conventional Commits #2006
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
Adds a commit-msg hook that validates commit messages follow the Conventional Commits format before allowing the commit. This prevents commits with incorrectly formatted messages (e.g., 'Fix:' instead of 'fix:') and ensures compatibility with our GitHub CI checks. The hook is installed via: cp .githooks/commit-msg .git/hooks/ chmod +x .git/hooks/commit-msg Or configure git to use the hooks directory: git config core.hooksPath .githooks [AI-assisted debugging and comment]
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
Adds a
commit-msghook that validates commit messages follow Conventional Commits format locally, preventing CI failures.Problem
PR #2004 failed CI because the PR title used
Fix:(capital F) instead offix:(lowercase f). The Conventional Commits CI check only runs on GitHub, so there was no local feedback before pushing.Solution
Added
.githooks/commit-msgthat validates commit messages locally before allowing the commit. This catches formatting issues (like capital letters in type) immediately.Installation
Users can install the hook via:
Or configure git to use the hooks directory:
Tested
The hook correctly:
Fix: message(capital F)fix: message(lowercase f)fix(core)!: message)Benefits
[AI-assisted debugging and comment]