Git : コミットメッセージに自動でブランチ名を挿入する
参考:How to add Git's branch name to the commit message?
- .git/hooks/ 下にある prepare-commit-msg.sample を prepare-commit-msg に変更する(.sample を外す)
- prepare-commit-msg に以下のようなスクリプトを追記する
branchPath=$(git symbolic-ref -q HEAD) # branchPath は refs/heads/feature/XXXX_YYYY のような文字列に branchName=${branchPath##*/} # 最後の / 以下を取得し、branchName は XXXX_YYYY のような文字列に issueNumber=$(echo $branchName | cut -d "_" -f 1) # "_" を delimiter として cut し、issueNumber は XXXX に firstLine=$(head -n1 $1) if [ -z "$firstLine" ] ;then # 最初の行が空行かチェックして、amend でないことを確認 sed -i "1s/^/($issueNumber) \n/" $1 # コミットメッセージの先頭に (XXXX) という文字列でブランチの情報を追加。 fi
参考先に少し修正を加え、branchName を直接使うのではなく、cut を使ってその一部を使うようにしています。
例えば feature/XXXX_YYYY
というブランチ名だった場合、コミットメッセージには (XXXX) という形でブランチ名の一部が入るようになります。
これは、自分は XXXX の部分にイシューやタスクの番号を、YYYY の部分に少し説明的な文章を入れる形でブランチ名を作っているためです。