Synopsis

git notes add [-m <msg>] [<commit>]
git notes show [<commit>]
git notes append [-m <msg>] [<commit>]
git notes remove [<commit>]

Description

The git notes command attaches additional metadata to commits without rewriting them. Notes are stored in their own ref namespace (refs/notes/commits by default) and are displayed alongside commits in git log. Use cases include code review comments, build status, ticket links, or sign-offs added after the fact.

Notes are not pushed by default — you must explicitly git push origin refs/notes/*. Different teams use different namespaces; CI systems often write to refs/notes/ci while reviewers use refs/notes/review.

Dans l'usage quotidien, git notes s'intègre étroitement avec les alias de shell, les plugins d'éditeur et l'intégration continue. Les utilisateurs avancés ajoutent souvent des alias combinant les flags qu'ils passent toujours, ou enveloppent la commande dans des scripts qui appliquent les conventions d'équipe. Le formatage de la sortie peut être personnalisé via la configuration Git — pretty formats, schémas de couleurs et comportement du pager sont tous ajustables. Quand quelque chose tourne mal, la première étape de diagnostic est généralement de relancer la commande avec GIT_TRACE=1 dans l'environnement, ce qui révèle les appels de plomberie sous-jacents. Pour les situations inhabituelles, la sortie --help (git notes --help) ouvre la page de manuel complète avec les détails de chaque option, y compris celles rarement utilisées dans les workflows ordinaires mais essentielles pour le débogage ou le scripting à grande échelle.

Comprendre comment git notes interagit avec le reste du modèle de données de Git — la base d'objets, l'index, les refs et l'arborescence de travail — est rentable. Chaque commande opère sur un sous-ensemble de ces pièces, et savoir laquelle elle touche aide à prédire les résultats et récupérer après les erreurs. Lire la documentation officielle de Git en parallèle de la pratique sur un dépôt jetable est la façon la plus rapide d'intérioriser les subtilités. La plupart des problèmes de production avec Git proviennent de l'une de trois causes : comportement par défaut surprenant, opérations réseau partielles, ou réécriture d'historique déjà partagé. Un modèle mental fonctionnel des effets de bord de git notes aide à éviter les trois.

Options courantes

Exemples

git notes add -m "Reviewed by Alice" abc123
# Attach a review note

git log --show-notes
# Show notes inline with log

git notes --ref=ci add -m "Build #42 passed" HEAD
# Use a custom namespace

git push origin 'refs/notes/*'
# Publish notes to the remote

Erreurs fréquentes

Forgetting to push and fetch the notes ref makes notes invisible to collaborators. Configure notes.displayRef = refs/notes/* so all namespaces show in git log. Notes don't survive history rewrites unless explicitly migrated.

Commandes liées

git log, git commit, git push, git fetch