Sommaire

Les notes Git Note Git

Git propose un système permettant d’attribuer des commentaires à des commits. Ce système de notes ne remplace absolument pas le message de commit. Contrairement aux messages de commit, les notes Git ne modifient pas le commit. Les notes sont attachées à un commit sans le modifier. Cela permet par exemple d’ajouter des détails concernant un commit ou encore de suivre les revues de code d’un commit.

Dans une équipe utilisant gt-flow, il est d’ailleurs tout à fait possible au dernier commit des branches hotfix d’ajouter une note avec un flag #readyToDeploy pour spécifier que le commit est prêt à être déployé. Ce type de flag n’aurait rien à faire dans un message de commit car il ne pourrait pas être supprimé, alors qu’avec les notes c’est possible.

1. Créer une note

Pour créer une note sur un commit, il faut utiliser la commande suivante :

git notes add <commit>

Il est possible d’utiliser l’argument -m pour définir le message ou alors de laisser Git ouvrir l’éditeur de texte.

Une fois le message validé, Git crée un nouvel objet correspondant au message et l’attache au commit. Il faut rester vigilant lorsqu’on enregistre une note sur un commit à partir d’une référence dynamique. Une note enregistrée sur master ne correspondra plus à master lorsqu’un nouveau ...