Démarrer un message de validation git avec un hachage (#)

Git traite les lignes commençant par des #lignes de commentaire lors de la validation. cela est très ennuyeux lorsque vous travaillez avec un système de suivi des tickets et que vous essayez d'écrire le numéro de ticket au début de la ligne, par exemple

#123 salt hashed passwords

git supprimera simplement la ligne du message de validation. existe-t-il un moyen d'échapper au hachage? j'ai essayé \et !, mais rien ne fonctionne. les espaces avant #sont préservés, ils ne sont donc pas non plus une solution de travail au problème.

Ce comportement fait partie du comportement de git commit«nettoyage» par défaut de «. Si vous souhaitez conserver les lignes commençant par, #vous pouvez utiliser un autre mode de nettoyage.

Par exemple

git commit --cleanup=whitespace

Si vous faites cela, vous devez faire attention à supprimer toutes les #lignes que vous ne souhaitez pas voir apparaître dans le commit.

Notez que, depuis git1.8.2 (février 2013) , vous pouvez utiliser un caractère différent de ' #' pour la ligne commentée dans le message de validation.

Cela vous permet d'utiliser ' #' pour votre référence de numéro de bogue.

Les diverses lignes "d'indice" que Git donne quand il demande à l'utilisateur de modifier les messages dans l'éditeur sont commentées avec " #" par défaut.

La core.commentCharvariable de configuration peut être utilisée pour personnaliser ce ' #' en un caractère différent.

En théorie, vous pourriez mettre un core.commentCharmot (plusieurs caractères), mais git 2.0.x / 2.1 sera plus strict (Q3 2014).

Voir commit 50b54fd par Nguyễn Thái Ngọc Duy ( pclouds) :

config: soyez strict sur core.commentChar

Nous ne prenons pas en charge les chaînes de commentaires (du moins pas encore). Et le codage de caractères multi-octets pourrait également être mal interprété.

Le test avec deux virgules est mis à jour car il viole cela. Il est ajouté avec le correctif introduit core.commentChardans eff80a9 (Autoriser le "commentaire personnalisé" personnalisé - 16/01/2013). Je ne comprends pas pourquoi ce comportement est souhaité.

git 2.0.x / 2.1 (Q3 2014) ajoutera une sélection automatique pour core.commentChar:
Voir commit 84c9dc2

Quand core.commentCharest " auto", le caractère de commentaire commence par ' #' comme par défaut mais s'il est déjà dans le message préparé, trouvez un autre caractère dans un petit sous-ensemble. Cela devrait empêcher les surprises car git supprime certaines lignes de manière inattendue.

Notez que git n'est pas assez intelligent pour reconnaître ' #' comme le caractère de commentaire dans les modèles personnalisés et le convertir si le caractère de commentaire final est différent.
Il pense que les lignes «#» dans les modèles personnalisés font partie du message de validation. Ne l'utilisez donc pas avec des modèles personnalisés.

La liste des personnages candidats pour "auto" est:

# ; @ ! $ % ^ & | :

Cela signifie qu'une commande comme git commit -m '#1 fixed issue'basculera automatiquement le commentChar sur ' ;', car ' #' a été utilisé dans le message de validation.

Les réponses ici sont bonnes et détaillées, mais pour un git noob comme moi, la personnalisation des options de configuration de git n'est pas si évidente. Voici un exemple pour passer de #à ;pour les caractères de commentaire:

git config core.commentChar ";"

C'est tout ce que vous devez faire.

Vous pouvez utiliser l'option de ligne de commande -m:

git commit -m "#123 fixed"

Si vous faites un rebase interactif, alors lorsque vous enregistrez votre message de validation sans rien (car #au début, il en a fait un commentaire et donc il a été ignoré) git vous montrera quoi faire:

Aborting commit due to empty commit message.
Could not amend commit after successfully picking 5e9159d9ce3a5c3c87a4fb7932fda4e53c7891db... 123 salt hashed passwords
This is most likely due to an empty commit message, or the pre-commit hook
failed. If the pre-commit hook failed, you may need to resolve the issue before
you are able to reword the commit.
You can amend the commit now, with

        git commit --amend

Once you are satisfied with your changes, run

        git rebase --continue

Donc, modifiez simplement le message:

git commit --amend -m "#123 salt hashed passwords"

et continuez le rebase:

git rebase --continue

git commit --cleanup=scissorsDevrait être utilisé. Il est ajouté à Git v2.0.0 le 2014.05.21

de git commit --help

--cleanup=<mode>
  scissors
    Same as whitespace, except that everything from (and including) the line
    "# ------------------------ >8 ------------------------" is truncated if the message
    is to be edited. "#" can be customized with core.commentChar.

Utilisez un préfixe différent pour le numéro de ticket. Ou ajoutez un mot au numéro du ticket, comme "Bug # 42". Ou ajoutez un seul espace à la ligne; si vous souhaitez supprimer cet espace, vous pouvez ajouter un crochet de validation pour cela.

Personnellement, je préférerais que ce type de manipulation de message de validation ne soit pas effectué par un hook, car cela peut être très irritant lorsqu'il se déclenche lorsque vous ne le souhaitez pas. La solution la plus simple est probablement de repenser le problème.

Tous mes engagements commencent par #issueNumberdonc j'ai mis ce passe-partout à mon vim .git/hooks/commit-msg:

NAME=$(git branch | grep '*' | sed 's/* //') 
echo "$NAME"' '$(cat "$1") > "$1"

Supposons donc que nous ayons une branche #15et que nous fassions un message de validation add new awesome feature. Avec cette approche, le message final de validation sera #15 add new awesome feature.