¿Cómo anotar una rama?

Question

¿Hay alguna manera de anotar una rama? Sería bueno poder hacer algo como:

 
$ git notes add branch-name -m 'This branch is for whatever' 

pero que por supuesto no es muy útil, ya que la nota está relacionada con el actual jefe de la rama en lugar de la propia oficina.

Una solución fácil es soltar un README.branch-name en el repositorio, pero parece torpe. Un poco más elegante es tener una rama huérfana que no contenga nada más que README.branch-names. Estoy buscando una forma de registrar cuál es el propósito de la rama, además de simplemente ponerlo en el mensaje de confirmación para la "primera" confirmación de la rama. Puse "primero" entre comillas porque no siempre está claro lo que significa eso, que es la razón por la cual no es conveniente colocar la discusión en un mensaje de compromiso. A menudo es difícil encontrar la confirmación en la que se graba ese mensaje.

Answer 1

Este sería un enfoque totalmente diferente que git note, pero podría usar git config para esta funcionalidad.

$ git config branch.<branch-name>.note 'This is what this branch is for'

Esto puede tener un alias para hacer la interfaz más simple (supongo que esto puede ser mejorado pero esto es lo que yo uso):

$ git config alias.branch-note '!git config branch.$(git symbolic-ref --short HEAD).note $(if [ $# -gt 0 ]; then $1; fi)'

Esto le permite establecer la nota al igual que la rama (asegúrese de que usted cita la nota):

$ git branch-note 'This is what this branch is for'

A continuación, puede recuperar las ramas actuales señalan como esto:

$ git branch-note 
This is what this branch is for 

Como beneficio adicional, las entradas de configuración definidos en el espacio de nombres branch.<branch-name> seguirá los cambios de nombre de rama y ser limpiado automáticamente si se elimina la rama más tarde. Estas entradas de configuración superfluas solo persistirán mientras exista la rama, y ​​en ese momento se eliminarán automáticamente.

Una desventaja de este enfoque es que sólo se puede almacenar una "nota" por sucursal. Las llamadas subsiguientes de nota de bifurcación con un argumento sobrescribirán la nota de bifurcación anterior. Tampoco obtendrá el beneficio de almacenar el mensaje en un objeto git rastreable, pero tal vez sea suficiente para sus propósitos.

Answer 2

No. Las notas se adjuntan a identificadores de confirmación específicos.

Answer 3

Puede crear un "error de seguimiento" en su rastreador de problemas donde describe la gran característica nueva en gran detalle, con maquetas y diagramas UML y todo, y luego el nombre de la rama bug1234.

Answer 4

Usando la solución de Brian, he creado git-note. Se puede utilizar como:

$ git note "Some note" # set note for current branch 
$ git note -b branch # see note for branch 
$ git note -l # list all the branches with theirs' notes 

Answer 5

me gusta hacer cometer un vacío cada vez que se crea una nueva rama, con un mensaje de confirmación diciendo lo primero que hay que decir.

git branch B A 
git checkout B 
git commit --allow-empty -m "Created branch 'B' from 'A'" 

Esto también tiene un efecto secundario maravilloso de hacer la historia se muestra en "--graph git log" mucho clearer-- saber, que muestra un tenedor claramente marcado en el árbol en el momento creé el rama, en lugar de lo que normalmente se conseguiría que es un tenedor sin etiquetar claro en algún momento posterior cuando se me ocurre hacer mi primera, mientras que comprometerse en B-- ese tipo de cosas me mantiene en una niebla constante.

Answer 6

La respuesta correcta a esto es ahora descripciones de rama, una característica que se añadió a GIT después de esta pregunta fue hecha originalmente.

Aquí hay dos SO preguntas que surgen con esta respuesta: Branch descriptions in git Can I add a message/note/comment when creating a new branch in Git?