Как добавить имя ветки Git в сообщение коммита?

Мне нужна помощь с сценарием Bash, который автоматически добавит имя ветки git в качестве хэша в сообщения о фиксации.

Используйте 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].

Подробнее об описании веток вы можете найти в этом разделе вопросов и ответов .

Пример кода хранится в следующем 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 / крючки / подготовка-коммит-сообщение

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

добавьте приведенный ниже код в файл 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

Он добавит имя ветки в сообщение фиксации, кроме фиксации слияния. По умолчанию слияние-фиксация содержит информацию о ветке, поэтому дополнительное имя ветки не требуется и делает сообщение некрасивым.

Вдохновленный ответом Тима, который основан на верхнем ответе, оказывается, что ловушка prepare-commit-msg принимает в качестве аргумента, какой тип фиксации происходит . Как видно по умолчанию, prepare-commit-msg, если $ 2 - это 'merge', то это фиксация слияния. Таким образом, переключатель регистра можно изменить, включив в него функцию Тима 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файл с содержимым ответа Шитикова и поместите его в какую-нибудь папку:

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

Теперь включите хуки:

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

и git initснова в каждом проекте вы хотите его использовать.

У меня были проблемы с тем, чтобы эти решения работали на MacOS из-за того, что он использует BSD sedвместо GNU 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, вы можете просто избавиться от всего, от pipe до 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