Як додати ім'я гілки 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 / priprema-фіксація-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

Ви можете зробити це за допомогою комбінації гачків підготовки-фіксації та попереднього фіксації.

.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

додайте нижче наведений код у файл-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

Він додасть ім'я гілки для повідомлення повідомлення, за винятком об'єднання-фіксування. За замовчуванням злиття-фіксація містить інформацію про відділення, тому додаткова назва гілки не потрібна, і повідомлення стає некрасивим.

Натхненний відповіддю Тіма, який ґрунтується на верхній відповіді, виявляється, гак priprav-фіксації-msg береться за аргумент того, який тип комісії відбувається . Як видно з замовчування priprav-commit-msg, якщо $ 2 є "злиттям", то це об'єкт злиття. Таким чином, вимикач регістру може бути змінений, щоб він включав функцію Тіма 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. Якщо назва вашого відділення - лише номер вашого квитка Джира, ви можете просто позбутися від усього, починаючи від "F2". Це також вимагає, щоб .gitmessageу вашому домашньому каталозі був файл, названий .

Якщо ви хочете, щоб квиток JIRA був доданий до повідомлення про фіксацію, скористайтеся нижче сценарієм.

Повідомлення про щось, наприклад, для PROJECT-2313: Add awesome feature цього потрібна назва вашої філії, щоб розпочати з jira Ticket.

Це поєднання цих рішень:

• 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