Wie füge ich den Git-Filialnamen zur Commit-Nachricht hinzu?

Ich benötige Hilfe bei einem Bash-Skript, das automatisch den Zweignamen des Git als Hash in Commit-Nachrichten hinzufügt.

Verwenden Sie den prepare-commit-msgoder commit-msg Githook .

In Ihrem PROJECT/.git/hooks/Verzeichnis befinden sich bereits Beispiele .

Aus Sicherheitsgründen müssen Sie einen solchen Hook für jedes Repository, das Sie verwenden möchten, manuell aktivieren. Sie können das Skript jedoch festschreiben und auf alle Klone in das .git/hooks/Verzeichnis kopieren .

Hier ist mein commit-msgSkript als Beispiel:

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

Erstellt die folgende Festschreibungsnachricht:

[branch_name]: [original_message]

[branch_description]

Ich verwende die Ausgabenummer als branch_name, die Problembeschreibung wird in den Befehl branch_descriptionusing git branch --edit-description [branch_name]eingefügt.

Weitere Informationen zu Branchenbeschreibungen finden Sie in diesen Fragen und Antworten .

Das Codebeispiel ist in der folgenden Übersicht gespeichert .

Ein etwas einfacheres Skript, das den Zweignamen zur Festschreibungsnachricht hinzufügt, bevor Sie sie bearbeiten. Wenn Sie es also ändern oder entfernen möchten, können Sie dies tun.

Erstellen Sie diese Datei .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

Sie können dies mit einer Kombination aus den Hooks prepare-commit-msg und pre-commit tun.

.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

Berechtigungen festlegen

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

Fügen Sie den folgenden Code in die Datei prepare-commit-msg ein.

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

Es wird ein Zweigname zur Festschreibungsnachricht hinzugefügt, mit Ausnahme von Merge-Commit. Das Merge-Commit enthält standardmäßig Zweiginformationen, sodass kein zusätzlicher Zweigname erforderlich ist und die Nachricht hässlich wird.

Inspiriert von Tims Antwort, die auf der obersten Antwort aufbaut, stellt sich heraus, dass der Hook "prepare-commit-msg" ein Argument dafür ist, welche Art von Festschreibung stattfindet . Wie in der Standard-Prepare-Commit-Nachricht zu sehen ist, handelt es sich bei $ 2 um 'Merge', dann um ein Merge-Commit. Daher kann der Fallschalter so geändert werden, dass er Tims Funktion addBranchName () enthält.

Ich habe meine eigene Präferenz für das Hinzufügen des Zweignamens und alle nicht kommentierten Teile des Standard- prepare-commit-msg.sampleHooks angegeben.

prepare-commit-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

Wenn Sie es global machen möchten (für alle Projekte):

Erstellen Sie eine git-msgDatei mit dem Inhalt von shytikovs Antwort und legen Sie sie in einem Ordner ab:

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

Aktivieren Sie nun Hooks:

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

und git initwieder in jedem Projekt, das Sie verwenden möchten.

Ich hatte Probleme, diese Lösungen unter MacOS zum Laufen zu bringen, da BSD sedanstelle von GNU verwendet wird sed. Ich habe es geschafft, ein einfaches Skript zu erstellen, das die Arbeit erledigt. Immer noch mit .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 

Dies setzt einen ähnlichen Namensnamen für Zweige voraus functional-desc_JIRA-NUMBER. Wenn Ihr Filialname nur Ihre Jira-Ticketnummer ist, können Sie einfach alles von der Pipe bis zur f2 loswerden. Es erfordert auch, dass Sie eine Datei mit dem Namen .gitmessagein Ihrem Home-Verzeichnis haben.

Wenn Sie möchten, dass das JIRA-Ticket zur Festschreibungsnachricht hinzugefügt wird, verwenden Sie das folgende Skript.

Nachricht so etwas wie festschreiben PROJECT-2313: Add awesome feature Dies erfordert, dass Ihr Filialname mit dem jira Ticket beginnt.

Dies ist eine Kombination dieser Lösungen:

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

Es wurde für OS X mit dem geändert sed -i '.bak' und funktioniert auch mit 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