如何将Git的分支名称添加到提交消息中？

Question

我需要一些Bash脚本的帮助,它会自动将git的分支名称添加为提交消息中的哈希.

Answer 1

这是我的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]命令中.

有关此问答的分支说明的更多信息.

代码示例存储在以下Gist中.

Answer 2

使用prepare-commit-msg或commit-msg githook.

您的PROJECT/.git/hooks/目录中已有示例.

作为安全措施,您必须在要使用它的每个存储库上手动启用此类挂钩.但是,您可以提交脚本并将其复制到所有克隆中的.git/hooks/目录中.

Answer 3

一个更简单的脚本,在编辑之前将分支名称添加到提交消息中.因此,如果您想要更改或删除它,您可以.

创建此文件.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

Answer 4

您可以使用prepare-commit-msg和pre-commit钩子的组合来完成它.

的.git /钩/准备提交-MSG

#!/bin/sh

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

的.git /钩/预提交

#!/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

Answer 5

在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之外的消息.合并提交默认具有分支信息,因此不需要额外的分支名称并使消息变得丑陋.

Answer 6

如果您希望将 JIRA 票证添加到提交消息中，请使用以下脚本。

提交类似这样的消息PROJECT-2313: Add awesome feature ，这要求您的分支名称以 jira Ticket 开头。

这是以下解决方案的组合：

• /sf/answers/1208960371/
• 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

Answer 7

受蒂姆基于最高答案的答案的启发，事实证明prepare-commit-msg钩子将发生哪种提交作为参数。从默认的prepare-commit-msg中可以看到，如果$ 2是'merge'，则它是一个合并提交。因此，可以将大小写开关更改为包括Tim的addBranchName（）函数。

对于如何添加分支名称以及默认prepare-commit-msg.sample钩子中所有未注释的部分，我已经包含了自己的偏好。

准备提交消息

#!/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

Answer 8

如果你想使其成为全球性的（对于所有项目）：

使用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再次在您想要使用它的每个项目中。

Answer 9

我编辑了这个答案（/sf/answers/1208960371/），因此它也适用于名称中包含斜杠的分支，@而不是/用作sed分隔符。现在使用 . 获取分支名称也更简单git branch --show-current。我还将分支名称移至提交消息的底部，因为消息的实际标题是您首先看到的更有意义。

该文件仍应称为.git/hooks/prepare-commit-msg.

#!/bin/bash

branchName=$(git branch --show-current)
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@^@\n\n$branchName@" $1 #Insert branch name at the end of the commit message file
fi