利用 Git hook 自動將 branch 名稱放在 commit message 中

為了快速修正主線上的嚴重錯誤時，有時會另開一個 hotfix_issue_ooo 之類的分支(branch) ，然後在 commit message 中標上關鍵字 hotfix_issue_ooo 之類的，讓其他開發者知道這是一個 hotfix 。

上述情況，除了用手工標上關鍵字之外，還可以善用 Git 提供的 hook - prepare-commit-msg ，在 commit 時自動產生一些 commit message 。

所以更有效率的方式是利用 prepare-commit-msg 自動將分支名稱放到 commit message 中，如此一來就不需要特別再手動標上關鍵字了。

prepare-commit-msg #

<your_repo>/.git/hooks/ 資料夾底下有許多 Git 提供的 hooks 範例，其中一個 prepare-commit-msg.sample 就是本文的主角，利用以下指令複製一份：

$ cd <your_repo>/.git/hooks/
$ cp prepare-commit-msg.sample prepare-commit-msg

接著編輯它：

#!/bin/sh
COMMIT_MSG_FILE=$1
COMMIT_SOURCE=$2
SHA1=$3

if [ -z "$BRANCHES_TO_SKIP" ]; then
  BRANCHES_TO_SKIP=(master develop test)
fi

BRANCH_NAME=$(git symbolic-ref --short HEAD)

BRANCH_EXCLUDED=$(printf "%s\n" "${BRANCHES_TO_SKIP[@]}" | grep -c "^$BRANCH_NAME$")
BRANCH_IN_COMMIT=$(grep -c "\[$BRANCH_NAME\]" $1)

if [ -n "$BRANCH_NAME" ] && ! [[ $BRANCH_EXCLUDED -eq 1 ]] && ! [[ $BRANCH_IN_COMMIT -ge 1 ]]; then
  sed -i .bak -e "1s/^/[$BRANCH_NAME] /" $COMMIT_MSG_FILE
fi

在此稍微解說一下上述 shell script 。

COMMIT_MSG_FILE=$1
COMMIT_SOURCE=$2
SHA1=$3

上述是 Git 執行 prepare-commit-msg 時會一併傳進來的變數，是固定格式，因此不用多做修改。

if [ -z "$BRANCHES_TO_SKIP" ]; then
  BRANCHES_TO_SKIP=(master develop test)
fi

上述設定不自動標上分支名稱的 branch ，也就是在 master, develop, test 3 條線上不需要自動標上分支名稱。

BRANCH_NAME=$(git symbolic-ref --short HEAD)

上述取得當前所在的分支名稱。

BRANCH_EXCLUDED=$(printf "%s\n" "${BRANCHES_TO_SKIP[@]}" | grep -c "^$BRANCH_NAME$")
BRANCH_IN_COMMIT=$(grep -c "\[$BRANCH_NAME\]" $1)

if [ -n "$BRANCH_NAME" ] && ! [[ $BRANCH_EXCLUDED -eq 1 ]] && ! [[ $BRANCH_IN_COMMIT -ge 1 ]]; then
  sed -i .bak -e "1s/^/[$BRANCH_NAME] /" $COMMIT_MSG_FILE
fi

最後判斷當前分支名稱是否為不需要自動標上關鍵字的分支，最後用 sed -i .bak -e "1s/^/[$BRANCH_NAME] /" $COMMIT_MSG_FILE 將 $COMMIT_MSG_FILE 檔案中的內容開頭加上 [分支名稱] ，如此一來就完成自動標上分支名稱的任務了！

以上， Happy Coding!

git hook prepare-commit-msg