Làm cách nào để thêm tên chi nhánh của Git vào thông báo cam kết?

Tôi cần một số trợ giúp với tập lệnh Bash sẽ tự động thêm tên chi nhánh của git làm băm trong các thông báo cam kết.

Sử dụng prepare-commit-msghoặc commit-msg githook .

Có những ví dụ đã có trong PROJECT/.git/hooks/thư mục của bạn .

Như một biện pháp bảo mật, bạn sẽ phải kích hoạt thủ công một hook như vậy trên mỗi kho lưu trữ mà bạn muốn sử dụng nó. Mặc dù vậy, bạn có thể cam kết tập lệnh và sao chép nó trên tất cả các bản sao vào .git/hooks/thư mục.

Đây là commit-msgtập lệnh của tôi làm ví dụ:

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

Tạo thông báo cam kết sau:

[branch_name]: [original_message]

[branch_description]

Tôi đang sử dụng số vấn đề như branch_name, mô tả vấn đề được đặt vào lệnh branch_descriptionusing git branch --edit-description [branch_name].

Bạn có thể tìm thấy thêm về mô tả chi nhánh trong phần Hỏi và Đáp này .

Ví dụ mã được lưu trữ trong Gist sau đây .

Một tập lệnh đơn giản hơn một chút bổ sung tên nhánh vào thông báo cam kết trước khi bạn chỉnh sửa nó. Vì vậy, nếu bạn muốn thay đổi hoặc loại bỏ nó, bạn có thể.

Tạo tệp này .git / hooks / standard-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

Bạn có thể làm điều đó với sự kết hợp của hook chuẩn bị-commit-msg và pre-commit.

.git / hooks / standard-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

Đặt quyền

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

thêm mã bên dưới vào tệp tin chuẩn bị.

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

Nó sẽ thêm tên nhánh vào thông báo cam kết ngoại trừ hợp nhất-cam kết. Hợp nhất-cam kết có thông tin nhánh theo mặc định vì vậy tên nhánh bổ sung là không cần thiết và làm cho thông báo trở nên xấu xí.

Lấy cảm hứng từ câu trả lời của Tim được xây dựng dựa trên câu trả lời hàng đầu, hóa ra hook chuẩn bị-cam kết-msg lấy làm đối số về loại cam kết nào đang xảy ra . Như đã thấy trong standard-commit-msg mặc định nếu $ 2 là 'hợp nhất' thì đó là một cam kết hợp nhất. Do đó, công tắc trường hợp có thể được thay đổi để bao gồm hàm addBranchName () của Tim.

Tôi đã bao gồm tùy chọn của riêng mình về cách thêm tên nhánh và tất cả các phần không có chú thích của prepare-commit-msg.samplehook mặc định .

chuẩn bị-cam kết-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

Nếu bạn muốn đưa nó ra toàn cầu (cho tất cả các dự án):

Tạo git-msgtệp với nội dung câu trả lời của shytikov và đặt nó vào thư mục nào đó:

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

Bây giờ hãy kích hoạt hook:

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

và git initmột lần nữa trong mỗi dự án bạn muốn sử dụng nó.

Tôi gặp sự cố khi đưa các giải pháp này hoạt động trên MacOS do thực tế là nó sử dụng BSD sedthay vì GNU sed. Mặc dù vậy, tôi đã cố gắng tạo một tập lệnh đơn giản để thực hiện công việc. Vẫn đang sử dụng .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 

Điều này giả định một tiêu chuẩn đặt tên nhánh tương tự như functional-desc_JIRA-NUMBER. Nếu tên chi nhánh của bạn chỉ là số vé Jira của bạn, bạn chỉ cần loại bỏ mọi thứ từ đường ống đến f2. Nó cũng yêu cầu bạn có một tệp có tên .gitmessagetrong thư mục chính của bạn.

Trong trường hợp bạn muốn thêm vé JIRA vào thông báo cam kết, hãy sử dụng đoạn mã dưới đây.

Thông báo cam kết như thế PROJECT-2313: Add awesome feature này yêu cầu tên chi nhánh của bạn phải bắt đầu bằng Vé jira.

Đây là sự kết hợp của các giải pháp này:

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

Nó được sửa đổi cho OS X, với sed -i '.bak'và nó hoạt động tốt từ 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