diff --git a/.hooks/prepare-commit-msg b/.hooks/prepare-commit-msg new file mode 100755 index 000000000000..d2d1536cfcca --- /dev/null +++ b/.hooks/prepare-commit-msg @@ -0,0 +1,69 @@ +#!/bin/sh + +# prepare-commit-msg: Prepare a commit message upon `git commit` for the +# user to edit. A script (rather than a static template) is used, so +# that we can insert our template text other than at the top of the +# message. +# +# Install by either setting the configuration of the repository to: +# git config --add core.hooksPath .hooks +# or copy it to the hooks directory, but it will not get automatically updated: +# cp .hooks/prepare-commit-msg .git/hooks/ + +case "$2" in +commit|message) + # It appears git invokes this script for interactive rebase but does + # not remove commented lines, so just exit if we're not called with the + # default (comment-containing) template. + grep -E -q '^#' "$1" || exit 0 + ;; +template) + exit 0 + ;; +merge) + exit 0 + ;; +esac + +outfile=$(mktemp /tmp/freebsd-git-commit.XXXXXXXX) + +# Create a commit message template from three parts: +# +# 1. The beginning of the git-provided template (up to the first comment-only +# line) which explains commented lines and such. +# +# 2. Our template. +# +# 3. The remainder of the git-provided template (from the first comment-only +# line to the end of the file) which lists files staged for commit, files +# not staged, and untracked files. + +cat >"$outfile" < +# 72 columns --| +# +# Uncomment and complete these metadata fields, as appropriate: +# +# PR: +# Reported by: +# Reviewed by: +# Tested by: +# Approved by: +# Obtained from: +# Fixes: +# MFH: +# Relnotes: +# Security: +# Sponsored by: +# Pull Request: /pull/###> +# Differential Revision: +# +# "Pull Request" and "Differential Revision" require the *full* GitHub or +# Phabricator URL. The commit author should be set appropriately, using +# \`git commit --author\` if someone besides the committer sent in the change. +$(awk '/^#$/,EOF' "$1") +EOF + +mv "$outfile" "$1"