Prepend the branch name to the commit message

commit-msg

#!/usr/bin/env bash

main() {
  local commit_message_file=$1

  local branch_name=$(__git_ps1 '%s' | cut -d '|' -f 1)
  local commit_message=$(cat "$commit_message_file")

  # do nothing if the commit_message already begins with the branch_name
  if [[ "$commit_message" == "$branch_name"* ]]; then
    return 0
  fi

  # prepend the branch name to the commit message
  printf "%s - %s" "$branch_name" "$commit_message" > "$commit_message_file"

  return 0
}

main "$@"

commit-msg.md

Git commit-msg hook

Prepend the branch name to the commit message.

Useful for workflows where the branch name is an issue number and the commits have to begin with it as well.

Usage

Put the commit-msg file inside your .git/hooks project repository.

Then, for the following commit, on a branch named ABC-1234:

git commit -m 'my thoughtful description'

The commit message will become:

ABC-1234 - my thoughtful description

🍻