Gitのブランチ名をコミットメッセージに追加するにはどうすればよいですか？

コミットメッセージでgitのブランチ名をハッシュとして自動的に追加するBashスクリプトのヘルプが必要です。

prepare-commit-msgまたはcommit-msg githookを使用します。

すでにPROJECT/.git/hooks/ディレクトリに例があります。

セキュリティ対策として、使用する各リポジトリでこのようなフックを手動で有効にする必要があります。ただし、スクリプトをコミットして、すべてのクローンで.git/hooks/ディレクトリにコピーできます。

ここにcommit-msg例として私のスクリプトがあります：

#!/bin/sh
#
# Automatically adds branch name and branch description to every commit message.
#
NAME=$(git branch | grep '*' | sed 's/* //') 
DESCRIPTION=$(git config branch."$NAME".description)

echo "$NAME"': '$(cat "$1") > "$1"
if [ -n "$DESCRIPTION" ] 
then
   echo "" >> "$1"
   echo $DESCRIPTION >> "$1"
fi 

次のコミットメッセージを作成します。

[branch_name]: [original_message]

[branch_description]

問題番号をとして使用しています。branch_name問題の説明はbranch_descriptionusing git branch --edit-description [branch_name]コマンドに配置されています。

このQ＆Aで見つけることができるブランチの説明の詳細。

コード例は、次のGistに格納されています。

編集する前に、ブランチメッセージをコミットメッセージに追加する少し単純なスクリプト。したがって、変更または削除したい場合は、できます。

このファイル.git / hooks / prepare-commit-msgを作成します。

#!/bin/bash

branchPath=$(git symbolic-ref -q HEAD) #Somthing like refs/heads/myBranchName
branchName=${branchPath##*/}      #Get text behind the last / of the branch path

firstLine=$(head -n1 $1)

if [ -z "$firstLine"  ] ;then #Check that this is not an amend by checking that the first line is empty
    sed -i "1s/^/$branchName: \n/" $1 #Insert branch name at the start of the commit message file
fi

prepare-commit-msgフックとpre-commitフックの組み合わせでそれを行うことができます。

.git / hooks / prepare-commit-msg

#!/bin/sh

BRANCH=`git branch | grep '^\*' | cut -b3-`
FILE=`cat "$1"`
echo "$BRANCH $FILE" > "$1"

.git / hooks / pre-commit

#!/bin/bash

find vendor -name ".git*" -type d | while read i
do
        if [ -d "$i" ]; then
                DIR=`dirname $i`
                rm -fR $i
                git rm -r --cached $DIR > /dev/null 2>&1
                git add $DIR > /dev/null 2>&1
        fi
done

権限を設定する

sudo chmod 755 .git/hooks/prepare-commit-msg
sudo chmod 755 .git/hooks/pre-commit

以下のコードをprepare-commit-msgファイルに追加します。

#!/bin/sh
#
# Automatically add branch name and branch description to every commit message except merge commit.
#

COMMIT_EDITMSG=$1

addBranchName() {
  NAME=$(git branch | grep '*' | sed 's/* //') 
  DESCRIPTION=$(git config branch."$NAME".description)
  echo "[$NAME]: $(cat $COMMIT_EDITMSG)" > $COMMIT_EDITMSG
  if [ -n "$DESCRIPTION" ] 
  then
     echo "" >> $COMMIT_EDITMSG
     echo $DESCRIPTION >> $COMMIT_EDITMSG
  fi 
}

MERGE=$(cat $COMMIT_EDITMSG|grep -i 'merge'|wc -l)

if [ $MERGE -eq 0 ] ; then
  addBranchName
fi

merge-commit以外のブランチメッセージをコミットメッセージに追加します。merge-commitにはデフォルトでブランチ情報があるため、追加のブランチ名は不要であり、メッセージが見苦しくなります。

上位の回答に基づいたTimの回答に触発されて、prepare-commit-msgフックが引数としてどのような種類のコミットが発生しているかがわかります。デフォルトのprepare-commit-msgに見られるように、$ 2が「マージ」の場合、それはマージコミットです。したがって、ケーススイッチを変更してTimのaddBranchName（）関数を含めることができます。

ブランチ名を追加する方法と、デフォルトprepare-commit-msg.sampleフックのすべてのコメント化されていない部分について、独自の設定を含めました。

prepare-commit-msg

#!/bin/sh

addMyBranchName() {
  # Get name of current branch
  NAME=$(git branch | grep '*' | sed 's/* //')

  # First blank line is title, second is break for body, third is start of body
  BODY=`cut -d \| -f 6 $1 | grep -v -E .\+ -n | cut -d ':' -f1 | sed '3q;d'`

  # Put in string "(branch_name/): " at start of commit message body.
  # For templates with commit bodies
  if test ! -z $BODY; then
    awk 'NR=='$BODY'{$0="\('$NAME'/\): "}1;' $1 > tmp_msg && mv tmp_msg "$1"
  else
    echo "title\n\n($NAME/):\n`cat $1`\n" > "$1"
  fi
}

# You might need to consider squashes
case "$2,$3" in
  # Commits that already have a message
  commit,?*)
  ;;

  # Messages are one line messages you decide how to handle
  message,)
  ;;

  # Merge commits
  merge,)
    # Comments out the "Conflicts:" part of a merge commit.
    perl -i.bak -ne 's/^/# /, s/^# #/#/ if /^Conflicts/ .. /#/; print' "$1"
  ;;

  # Non-merges with no prior messages
  *)
    addMyBranchName $1
  ;;
esac

グローバルにする場合（すべてのプロジェクトに対して）：

shytikovの回答のgit-msg内容を含むファイルを作成し、いくつかのフォルダーに配置します。

mkdir -p ~/.git_hooks
# make it executable
chmod a+x ~/.git_hooks/commit-msg

フックを有効にします。

git config --global init.templatedir '~/.git_hooks'

そしてgit init再びあなたがそれを使いたい各プロジェクトで。

sedGNUではなくBSD を使用しているため、MacOSでこれらのソリューションを機能させるのに問題がありましたsed。私はなんとかその仕事をする簡単なスクリプトを作成することができました。まだ使用中.git/hooks/pre-commit：

#!/bin/sh
BRANCH=$(cat .git/HEAD  | cut -d '_' -f2)
if [ ! -z "$BRANCH" ]
then
    echo "$BRANCH" > "/Users/username/.gitmessage" 
else
    echo "[JIRA NUMBER]" > "/Users/username/.gitmessage"
fi 

これは、と同様のブランチ命名標準を想定していfunctional-desc_JIRA-NUMBERます。ブランチ名がJiraチケット番号のみの場合、パイプからf2までのすべてを単純に取り除くことができます。また.gitmessage、ホームディレクトリに名前の付いたファイルが必要です。

JIRAチケットをコミットメッセージに追加したい場合は、以下のスクリプトを使用してください。

次のようなメッセージをコミットします PROJECT-2313: Add awesome feature するには、ブランチ名がjiraチケットで始まる必要があります。

これは、このソリューションの組み合わせです。

• https://stackoverflow.com/a/17270862/1256452
• https://community.atlassian.com/t5/Sourcetree-questions/SourceTree-and-git-prepare-commit-msg/qaq-p/254173#M20824

OS X用に変更されsed -i '.bak'ており、SourceTreeからも同様に機能します。

https://gist.github.com/georgescumihai/c368e199a9455807b9fbd66f44160095

#!/bin/sh
#
# A hook script to prepare the commit log message.
# If the branch name it's a jira Ticket.
# It adds the branch name to the commit message, if it is not already part of it.

branchPath=$(git symbolic-ref -q HEAD) #Somthing like refs/heads/myBranchName
branchName=${branchPath##*/}      #Get text behind the last / of the branch path

regex="(PROJECTNAME-[0-9]*)"

if [[ $branchName =~ $regex ]]
then
    # Get the captured portion of the branch name.
    jiraTicketName="${BASH_REMATCH[1]}"

    originalMessage=`cat $1`

    # If the message already begins with PROJECTNAME-#, do not edit the commit message.
    if [[ $originalMessage == $jiraTicketName* ]]
        then
        exit
    fi

    sed -i '.bak' "1s/^/$jiraTicketName: /" $1 #Insert branch name at the start of the commit message file
fi