Bagaimana cara menambahkan nama cabang Git ke pesan komit?

Saya butuh bantuan dengan skrip Bash yang secara otomatis akan menambahkan nama cabang git sebagai hash dalam pesan komit.

Gunakan prepare-commit-msgatau commit-msg githook .

Ada beberapa contoh di PROJECT/.git/hooks/direktori Anda .

Sebagai tindakan keamanan, Anda harus mengaktifkan pengait semacam itu secara manual pada setiap repositori yang ingin Anda gunakan. Padahal, Anda dapat memasukkan skrip dan menyalinnya pada semua klon ke dalam .git/hooks/direktori.

Berikut commit-msgskrip saya sebagai contoh:

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

Membuat pesan komit berikut:

[branch_name]: [original_message]

[branch_description]

Saya menggunakan nomor masalah karena branch_name, deskripsi masalah ditempatkan ke perintah branch_descriptionusing git branch --edit-description [branch_name].

Lebih lanjut tentang deskripsi cabang dapat Anda temukan di T&J ini .

Contoh kode disimpan dalam Gist berikut .

Skrip yang lebih sederhana yang menambahkan nama cabang ke pesan komit sebelum Anda mengeditnya. Jadi jika Anda ingin mengubah atau menghapusnya Anda bisa.

Buat file ini .git / hooks / prepared-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

Anda dapat melakukannya dengan kombinasi hook persiapan-commit-msg dan pra-commit.

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

Setel izin

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

tambahkan kode di bawah ini di file prepared-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

Ini akan menambahkan nama cabang untuk melakukan pesan kecuali merge-commit. Merge-commit memiliki informasi cabang secara default sehingga nama cabang tambahan tidak diperlukan dan membuat pesan menjadi jelek.

Terinspirasi oleh jawaban Tim yang dibangun di atas jawaban teratas, ternyata hook siap-commit-msg mengambil argumen seperti apa yang terjadi . Seperti yang terlihat di preparasi-commit-msg default jika $ 2 adalah 'merge' maka itu adalah komit gabungan. Jadi case switch dapat diubah untuk menyertakan fungsi addBranchName () Tim.

Saya telah menyertakan preferensi saya sendiri untuk bagaimana menambahkan nama cabang, dan semua bagian yang tidak diberi komentar dari prepare-commit-msg.samplehook default .

persiapkan-komit-pesan

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

Jika Anda ingin menjadikannya global (untuk semua proyek):

Buat git-msgfile dengan isi jawaban shytikov , dan taruh di beberapa folder:

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

Sekarang aktifkan kait:

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

dan git initsekali lagi di setiap proyek Anda ingin menggunakannya.

Saya mengalami masalah dalam mendapatkan solusi ini untuk bekerja di MacOS karena ia menggunakan BSD dan sedbukan GNU sed. Saya berhasil membuat skrip sederhana yang melakukan pekerjaan itu. Masih menggunakan .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 

Ini mengasumsikan standar penamaan cabang yang mirip dengan functional-desc_JIRA-NUMBER. Jika nama cabang Anda hanya nomor tiket Jira Anda, Anda dapat dengan mudah menyingkirkan semuanya mulai dari pipa hingga f2. Ini juga mengharuskan Anda memiliki file bernama .gitmessagedi direktori home Anda.

Jika Anda ingin tiket JIRA ditambahkan ke pesan komit, gunakan skrip di bawah ini.

Lakukan pesan seperti PROJECT-2313: Add awesome feature ini. Ini memerlukan nama cabang Anda diawali dengan Jira Ticket.

Ini adalah kombinasi dari solusi ini:

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

Itu dimodifikasi untuk OS X, dengan sed -i '.bak'dan bekerja juga dari 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