Aller au contenu principal

Git notes : annoter tes commits

Tape git notes add -m "texte" <hash> : Git attache une note au commit sans changer son hash. git log l'affiche sous le message, et git push origin refs/notes/commits la partage. Idéal pour les infos de review ou de déploiement.

GitQuest
Démo

Par Anaïs Sparesotto, développeuse web et responsable pédagogique · Mis à jour le

Annotation

C'est quoi git notes ?

git notes permet d'ajouter des annotations à des commits sans modifier leur hash. Les notes sont stockées séparément de l'historique.

C'est comme coller un post-it sur un commit : tu ajoutes du contexte supplémentaire (review, déploiement, bug lié) sans toucher au commit original.

Syntaxe de git notes

git notes add -m "texte"

Ajouter une note au dernier commit

git notes show <hash>

Afficher la note d'un commit

git notes remove <hash>

Supprimer une note

Git notes en pratique

Ajouter et gérer des annotations.

Ajouter une note

Gérer les notes

Quand utiliser git notes ?

Code review

Annoter les commits avec le statut de review (approuvé, demande de modifications) sans modifier l'historique.

Deploiement

Marquer les commits avec les infos de déploiement (date, environnement, version) pour la traçabilité.

Documentation

Ajouter du contexte supplémentaire à des commits anciens : liens vers des tickets, explications techniques, etc.

Erreurs courantes avec git notes

Oublier de push les notes

Les notes ne sont pas poussées par défaut. Utilise git push origin refs/notes/commits pour les partager avec l'équipe.

Perdre les notes lors d'un rebase

Un rebase change les hash des commits. Les notes sont liées aux anciens hash et ne suivent pas automatiquement. Utilise git notes copy pour les réassigner.

Écraser une note existante

Par défaut, git notes add refuse d'écraser une note existante. Utilise -f pour forcer, ou git notes append pour ajouter à la note existante.

Fait partie du guide Git avancé

A

GitQuest est conçu par Anaïs (nouvelle fenêtre), développeuse web et responsable pédagogique, spécialisée en formations tech et accessibilité numérique.

Questions sur git notes

Documente ton historique avec GitQuest

Apprends à enrichir ton historique Git avec des annotations et du contexte.