git notes

Inspección y comparación

Adjunta notas a commits sin cambiarlos


El comando 'git notes' adjunta texto extra a un commit — una revisión, un resultado de pruebas, una fecha de despliegue — sin tocar el propio commit, así su hash sigue igual. Las notas se guardan aparte (en refs/notes/commits) y git log las muestra bajo el mensaje del commit. No se suben ni se descargan por defecto.

Sinopsis

git notes [list [<object>]]
git notes add [-f] [-m <msg>] [<object>]
git notes append [-m <msg>] [<object>]
git notes show [<object>]
git notes remove [<object>...]
[ ] opcional| o<arg> valor a sustituir... repetible--flag opción

Opciones

Haz clic en una opción para desplegarla

Principiante (4)

Añade texto a la nota existente (o crea una).

RecomendadoAñadir información sin perder la nota existente

Ejemplo

git notes append -m "Tests pass"

Imprime la nota de un commit (HEAD por defecto).

RecomendadoLeer la nota de un commit

Ejemplo

git notes show HEAD~1

Lista cada nota: el id de la nota y el commit al que pertenece.

Cuando haga faltaEncontrar cada commit que tiene una nota

Ejemplo

git notes list

Borra la nota de un commit.

Cuando haga faltaQuitar una nota desactualizada

Ejemplo

git notes remove

Elegir la opción adecuada

Añadir información a un commit

¿Nota o amend?

Comando¿Cambia el hash?¿Seguro tras el push?
git commit --amendSíNo
git notes addNoSí

Ejemplos

Añadir una nota

git notes add -m "Reviewed by Sam"

Adjuntar una nota a HEAD.


Anotar un commit anterior

git notes add -m "Deployed" a1b2c3d

Cualquier commit puede tener una nota.


Compartir notas

git push origin refs/notes/commits

Las notas solo se suben si lo pides.

Ejemplos de flujos de trabajo

1
git notes add -m "Reviewed by Sam" a1b2c3d

Adjuntar la nota

2
git push origin refs/notes/commits

Compartirla con el equipo

Solución de problemas

error: Cannot add notes. Found existing notes

Causa: El commit ya tiene una nota

Usa git notes append, o add -f para reemplazarla

Mis compañeros no ven mis notas

Causa: Las notas no se suben por defecto

git push origin refs/notes/*, y tráelas con git fetch origin refs/notes/*:refs/notes/*

Consejos y trampas

Buenas prácticas

  • ✓Usa notas para la información que llega después del commit (revisiones, resultados de CI).

Errores comunes

  • ✗Enmendar un commit subido solo para añadir información — una nota conserva el hash.
  • ✗Esperar que las notas viajen con git push — sube refs/notes/* explícitamente.

Preguntas frecuentes

A:

No. Se guardan al lado; el commit y su hash siguen idénticos.