Comment annotez-vous une branche?

Question

Est-il possible d'annoter une branche? Il serait agréable d'être en mesure de faire quelque chose comme:

$ git notes ajouter branche-nom -m Cette branche est pour quoique ce soit"

mais bien sûr c'est pas très utile, puisque la remarque s'applique à l'actuel chef de la direction plutôt que la direction elle-même. Une simple solution de contournement consiste à déposer un fichier README.direction générale-nom dans le référentiel, mais qui semble maladroite. Un peu plus élégante est d'avoir un orphelin branche contenant rien, mais README.branche-noms. Je suis à la recherche d'un moyen d'enregistrer ce que l'objectif de la direction est d'autres qu'il suffit de le mettre dans le message de commit pour la "première" commit de la branche. J'ai mis "première" entre guillemets car il n'est pas toujours clairement ce qui est signifié par cela, ce qui est la raison pour laquelle il n'est pas pratique pour mettre le débat dans un message de commit. Il est souvent difficile de trouver le commettre un tel message est enregistré.

Answer 1

Ce serait une approche totalement différente de git note mais vous pouvez utiliser git config pour cette fonctionnalité.

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

Cela peut être un alias pour rendre l'interface plus simple (je suppose que ce qui peut être amélioré, mais c'est ce que j'utilise):

$ git config alias.branch-note '!git config branch.$(git symbolic-ref HEAD|sed "s/refs\/heads\///").note $( if [ $# -gt 0 ]; then $1; fi)'

Cela vous permet de définir la direction de la remarque comme (assurez-vous de la citation de la note):

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

Vous pouvez ensuite récupérer le courant branches note comme ceci:

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

Comme un avantage supplémentaire, config entrées définies en vertu de l' branch.<branch-name> de l'espace de noms suivront direction de la renomme et être automatiquement nettoyé si vous supprimez la direction de la plus tard. Ces superflu config entrées seulement durer aussi longtemps que la direction générale existe, au moment où ils seront automatiquement supprimés.

Un inconvénient de cette approche est que vous ne pouvez stocker qu'une "note" par la branche. Nouvelle branche-note des appels avec un argument qui remplace la précédente direction générale-note. Vous pouvez aussi ne pas obtenir le bénéfice de stocker le message dans un suivi git objet, mais peut-être que cela sera suffisant pour vos besoins.

Answer 2

En utilisant la solution de Brian, j'ai créé git-note . Vous pouvez l'utiliser comme:

 $ 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 3

Vous pouvez simplement créer un "bogue de suivi" dans votre suivi des problèmes dans lequel vous décrivez la grande nouvelle fonctionnalité de manière très détaillée, avec des maquettes et des diagrammes UML, etc., puis nommez la branche bug1234 .

Answer 4

Les notes sont attachées à des ID de validation spécifiques.