Skip to content

Instantly share code, notes, and snippets.

@tmiller
Last active December 15, 2015 06:28
Show Gist options
  • Save tmiller/5216062 to your computer and use it in GitHub Desktop.
Save tmiller/5216062 to your computer and use it in GitHub Desktop.
Using the gem ptb to prepare commit messages.

Usage

Place this file in my_project/.git/hooks/prepare-commit-msg to have git automatically use ptb to prepare your commit messages for you.

You also need to give execute permisions to prepare-commit-msg

chmod +x myproject/.git/hooks/prepare-commit-msg

Requirements

  • git >= 1.8.2
  • ptb >= 0.0.3
#!/bin/sh
#
# An example hook script to prepare the commit log message.
# Called by "git commit" with the name of the file that has the
# commit message, followed by the description of the commit
# message's source. The hook's purpose is to edit the commit
# message file. If the hook fails with a non-zero status,
# the commit is aborted.
#
# To enable this hook, rename this file to "prepare-commit-msg".
# This hook includes three examples. The first comments out the
# "Conflicts:" part of a merge commit.
#
# The second includes the output of "git diff --name-status -r"
# into the message, just before the "git status" output. It is
# commented because it doesn't cope with --amend or with squashed
# commits.
#
# The third example adds a Signed-off-by line to the message, that can
# still be edited. This is rarely a good idea.
case "$2" in
commit) ;;
squash) ;;
merge) ;;
message) ;;
template) ;;
*) /usr/bin/perl -pi -e 'print `ptb message` if $. == 1' "$1" ;;
esac
# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment