커밋 메시지에 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가 '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

글로벌로 만들려면 (모든 프로젝트에 대해) :

만들기 git-msg의 내용에 파일 shytikov의 답변을 , 어떤 폴더에 넣어 :

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