Comment annoter une branche?

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é.

git checkout -b long_branch_name_that_means_something
Dupliquer: stackoverflow.com/questions/2108405/branch-descriptions-in-git
D'un côté: Longue durée de vie de branches devraient être peu nombreux et bien connus comme maître ou de développer. Je pense que si vous avez que beaucoup de branches que vous avez besoin de les décrire, alors il est probable que vous avez un git problème de flux ou je suis malentendu comment vous utilisez git.
Double Possible de Direction des descriptions dans git

InformationsquelleAutor William Pursell | 2011-01-20

git

40

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 --short HEAD).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 la branch.<branch-name> espace de noms suivre la 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.
- Sera cette remarque être poussé à la hausse des dépots?
- Non, puisque c'est strictement un git config, il n'est pas poussé/tiré de n'importe où (comme pour tout le reste de vos options de configuration).
- il y a aujourd'hui dans un alias pour ce - git branch --edit-description - c'est juste que la propriété "description", pas "pas" git config branche.<branche-name>.description montrent que la description.
- Hey @BrianPhillips, cela fonctionne très bien pour moi... cependant, il fait parfois penser le premier mot de ma note est une commande... git branch-note "l'Ajout de marketing, aide à la connexion option de contact" => git config branche.$(git symbolique-ref TÊTE|sed "s/réf\/têtes de\///").note $( if [ $# -gt 0 ]; then $1; fi): Ajout: command not found
- Voir cette réponse: stackoverflow.com/questions/2108405/branch-descriptions-in-git pour git 1.7.9+ git-branch --edit-description de faire exactement ce que vous demandez.
- Comme une incidente, git symbolic-ref --short HEAD obtient le nom de la branche sans avoir à utiliser la sed pipeline.
InformationsquelleAutor Brian Phillips
12

Je tiens à faire un vide s'engager à chaque fois que je créer une nouvelle branche,
avec un message de validation de dire ce qui doit être dit.
```
git branch B A
git checkout B
git commit --allow-empty -m "Created branch 'B' from 'A'"
```
Cela a également un merveilleux effet secondaire de faire de l'histoire
indiqué dans "git log --graph" beaucoup plus clair--
à savoir qu'il montre clairement étiquetés la fourche de l'arbre
au moment où j'ai créé la direction générale,
au lieu de ce que j'avais normalement obtenir ce qui est clair et non de la fourche au bout d'un certain temps
quand il m'arrive de faire mon premier commit alors que dans B--
ce genre de chose me maintient dans un brouillard constant.
- Comment faites-vous pour récupérer le texte plus tard?
- Un "impair" effet secondaire de ceci est que votre commande git log sur le maître devrait contenir un message après la fusion de la direction.
InformationsquelleAutor Don Hatch
4

À l'aide de Brian solution que 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
```
- La lecture de ce commentaire " Stocke le texte de la note dans le dépôt git local config.' Ai-je raison de supposer que ceci ne fonctionne qu'en local et que quelqu'un l'obtention du référentiel distant de ne pas voir mon évolution?
- vous pouvez push/pull git notes afin qu'ils puissent être vus par tout le monde.
InformationsquelleAutor rkj
3

La bonne réponse à cette question est maintenant de la branche des descriptions, une fonctionnalité qui a été ajoutée à git après que cette question a été initialement demandé.

Voici deux questions qui viennent avec cette réponse:
Direction des descriptions dans git
Puis-je ajouter un message/note/commentaire lors de la création d'une nouvelle branche dans Git?
- Comme l'a souligné par au moins une personne dans chacune de ces réponses threads: qui ne peut pas être poussé et est donc inutile, pour moi, de toute façon.
InformationsquelleAutor skiphoppy
2

Vous pouvez simplement créer un "suivi de bug" dans votre outil de suivi vous permettent de décrire la grande nouvelle fonctionnalité dans les détails, avec des maquettes et des diagrammes UML et tout, et puis le nom de la branche bug1234.

InformationsquelleAutor MatrixFrog
0

Pas. Les Notes sont attachés à certains commettre Id.

InformationsquelleAutor Simon Richter
0

À l'aide de git tag --annoter balises avec les descriptions peuvent être créés.

La balise est techniquement attribuée à un commit au lieu d'une branche. Si tous les collaborateurs à s'entendre sur le nom de la branche (dans le cadre de l') le nom de la balise, la balise correspondante(s) à une branche peut être répertorié en utilisant le nom de la branche dans le cadre d'un modèle de filtre. Le -n option permet d'afficher l'annotation. Alias peut être pratique pour utiliser automatiquement l'actuel nom de la direction générale pour la création et la liste spéciale direction de la description des balises.

Note 1: git décrire peut être utilisé pour trouver la plus récente de la balise dans une branche. Malheureusement, cela peut liste des balises d'autres branches si elles sont regroupées dans la branche d'intérêt.

Note 2: Il est pas recommandé pour mettre à jour un tag HEAD manuellement à l'aide de --force.

Un avantage de l'utilisation des tags est que la description est disponible pour tous les collaborateurs.

InformationsquelleAutor user5534993

Vous devez vous connecter pour publier un commentaire.