Skip to content

Instantly share code, notes, and snippets.

Created July 17, 2012 21:07
  • Star 25 You must be signed in to star a gist
  • Fork 9 You must be signed in to fork a gist
Star You must be signed in to star a gist
What would you like to do?
commit-msg hook script
# Automatically adds branch name and branch description to every commit message.
NAME=$(git branch | grep '*' | sed 's/* //')
DESCRIPTION=$(git config branch."$NAME".description)
TEXT=$(cat "$1" | sed '/^#.*/d')
if [ -n "$TEXT" ]
echo "$NAME"': '$(cat "$1" | sed '/^#.*/d') > "$1"
if [ -n "$DESCRIPTION" ]
echo "" >> "$1"
echo $DESCRIPTION >> "$1"
echo "Aborting commit due to empty commit message."
exit 1
Copy link

azizmb commented Oct 22, 2012

Hi! Thanks for the script. One issue though. When I use this hook, I lose any line breaks in the commit messages. Any idea how to fix this?

Copy link

pzelnip commented Jul 16, 2013

On a "git commit -a" I always get "aborting commit due to empty commit message".

Copy link

Great post +11

Copy link

danwald commented Feb 20, 2015

you should put this in your prepare-commit-msg instead

Copy link

san7hos commented Mar 16, 2016

@danwald you cannot start lines with # in the vim editor, that makes it harder to put in the prepare hook

Copy link

synthesizerpatel commented May 3, 2017

A tiny amount of code golf for getting the branch name if you care:

NAME=$(git branch | sed -n -e 's/^* //gp')

Copy link

This is great, thank you. It has cause a little problem when doing an interactive rebase and attempting to reword a commit.

Copy link

rbobillot commented Jul 12, 2021

Also, if you just wanna get your branch name, without using sed, grep nor awk:
NAME=$(git symbolic-ref --short HEAD)
NAME=$(git branch --show-current)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment