Comment ajouter le nom de la branche de Git au message de livraison ?

Question

J'ai besoin d'aide pour un script Bash script qui ajoutera automatiquement le nom de la branche de git en tant que hash dans les messages de commit.

Answer 1

Voici mon commit-msg script comme exemple :

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

Crée le message de validation suivant :

[branch_name]: [original_message]

[branch_description]

J'utilise le numéro d'édition comme branch_name La description de l'émission est placée à l'adresse suivante branch_description en utilisant git branch --edit-description [branch_name] commandement.

Pour en savoir plus sur les descriptions de branches, consultez le site suivant Q&R .

L'exemple de code est stocké dans le document suivant Gist .

Answer 2

Utiliser le prepare-commit-msg o commit-msg githook .

Il y a déjà des exemples dans votre PROJECT/.git/hooks/ répertoire.

Par mesure de sécurité, vous devrez activer manuellement ce crochet sur chaque dépôt que vous souhaitez utiliser. Cependant, vous pouvez livrer le script et le copier sur tous les clones dans le fichier .git/hooks/ répertoire.

Answer 3

Un script un peu plus simple qui ajoute le nom de la branche au message de validation. avant vous l'éditez. Ainsi, si vous souhaitez le modifier ou le supprimer, vous pouvez le faire.

Créer ce fichier .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

Answer 4

Vous pouvez le faire en combinant les hooks prepare-commit-msg et pre-commit.

.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

Définir les autorisations

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

Answer 5

Ajouter le code ci-dessous dans le fichier 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

Il ajoutera le nom de la branche au message de validation, à l'exception de merge-commit. Le merge-commit contient par défaut des informations sur la branche le nom de la branche n'est donc pas nécessaire et rend le message moche.