git hook - prefix your commit message with your JIRA ticket


If you follow gitflow or github-flow you will have branch names like this: feature/JIRA-1234-My-Feature or bugfix/ABC-121-Issue. And most of the times your commit messages will start the same: JIRA-1234 Created the button or ABC-121 Reverted Refactoring.

The Hook

if [ -z "$BRANCHES_TO_SKIP" ]; then
  BRANCHES_TO_SKIP=(main develop)

BRANCH_NAME=$(git symbolic-ref --short HEAD)
TICKET_NAME=$(echo $BRANCH_NAME | grep -Poi '\w*/\K([0-9]+)')
BRANCH_EXCLUDED=$(printf "%s\n" "${BRANCHES_TO_SKIP[@]}" | grep -c "^$BRANCH_NAME$")
ALREADY_IN_MSG=$(grep -ci "$TICKET_NAME" $1)
if [ -n "$BRANCH_NAME" ] && ! [[ "$BRANCH_EXCLUDED" -eq 1 ]] && ! [[ "$ALREADY_IN_MSG" -eq 1 ]]; then
  sed -i.bak -e "1s/^/AB#${TICKET_NAME^^} /" "$1"

Now if you are on your feature/JIRA-1234-Something branch and created a commit message without your ticket it will automatically prefix your ticket, so:

git commit -m "Test"

Will result in

JIRA-1234 Test

If you still prefix your ticket with this, don't worry, this will not prefix your message a second time. And the git hook works in all GUI's (Visual Studio, Rider, Source-Tree) or via the CLI.

How to install?

To use it you have to go into the .git folder of your repository. There you find a hooks folder with a lot of sample files. The hook we have written is called prepare-commit-msg. So create a new file called prepare-commit-msg. There is no extension and copy the content et voilà: You save about 0.52 seconds per commit message 😉

Getting git version information in your C# code

Did you ever need git-specific information like the latest tag or the current commit inside your C# code? Or even the semantic version number of your current build=

Well, there is an easy solution involving source generators.

How to hunt down bugs with git bisect

This article will show how you can identify the commit a bug was introduced.

Sometimes it is hard to track down a bug. Your only chance is to exploratory test your code until you find the code in question. I will show you a way how to do this with git. More specific how to use git bisect

How to rebase onto a different branch with git

We're all been there. You worked on a feature or bug on your branch and after some commits you noticed "Oops, I should have branched from xyz instead of abc". I'll show you an easy way of simply moving your stuff from branch abc to xyz.

An error has occurred. This application may no longer respond until reloaded. Reload x