web-dev-qa-db-fra.com

Lien vers le numéro de publication sur GitHub dans un message de validation

Est-il possible en quelque sorte automatiquement d'avoir un lien vers le numéro d'émission de GitHub dans le message git commit?

gitgithubgit-commit
703
Mika Tuupola

Incluez simplement #xxx dans votre message de validation pour référencer un problème sans le fermer.

Avec new GitHub issues 2. , vous pouvez utiliser ces synonymes pour référencer un problème et le fermer le (dans votre message de validation):

  • fix #xxx
  • fixes #xxx
  • fixed #xxx
  • close #xxx
  • closes #xxx
  • closed #xxx
  • resolve #xxx
  • resolves #xxx
  • resolved #xxx

Vous pouvez également remplacer #xxx par gh-xxx.

Référencer et problèmes de fermeture sur plusieurs dépôts fonctionne également:

fixes user/repo#xxx

Consultez la documentation disponible dans leur section d'aide.

891
NARKOZ

Si vous souhaitez créer un lien vers un problème GitHub et fermer le problème, vous pouvez fournir les lignes suivantes dans votre message de validation Git:

Closes #1.
Closes GH-1.
Closes gh-1.

(N'importe lequel des trois fonctionnera.) Notez que cela va créer un lien vers le problème et également le fermer . Vous pouvez en savoir plus dans ceci article de blog (commencez à regarder la vidéo intégrée à environ 1h40).

Je ne sais pas si une syntaxe similaire permettra simplement de lier un problème sans le fermer.

164
mipadi

Vous pouvez également croiser les pensions:

githubuser/repository#xxx

xxx étant le numéro d'émission

63
narkeeso

github ajoute une référence au commit s'il contient #issuenbr (découvert par hasard).

60
Henrik Lindberg

ils ont un article sympa sur les nouveaux numéros 2.0 sur leur blog https://github.blog/2011-04-09-issues-2-0-the-next-generation/

les synonymes incluent

  • corrige #xxx
  • fixe #xxx
  • correction #xxx
  • ferme #xxx
  • fermer #xxx
  • fermé #xxx

l'utilisation de l'un des mots-clés dans un message de validation rendra votre validation mentionnée ou fermera un problème.

13
xero

Afin de lier le numéro de problème à votre message de validation, vous devez ajouter: #issue_number dans votre message de validation git.

Exemple de message de validation de Guide de style du message de validation par Udacity Git

feat: Summarize changes in around 50 characters or less

More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of the commit and the rest of the text as the body. The
blank line separating the summary from the body is critical (unless
you omit the body entirely); various tools like `log`, `shortlog`
and `rebase` can get confused if you run the two together.

Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequenses of this
change? Here's the place to explain them.

Further paragraphs come after blank lines.

 - Bullet points are okay, too

 - Typically a hyphen or asterisk is used for the bullet, preceded
   by a single space, with blank lines in between, but conventions
   vary here

If you use an issue tracker, put references to them at the bottom,
like this:

Resolves: #123
See also: #456, #789

Vous pouvez également référencer les référentiels:

githubuser/repository#issue_number
4
Suhas Srivats Subburathinam

Juste comme ajout aux autres réponses: Si vous ne voulez même pas écrire le message de validation avec le numéro d'édition et que vous utilisez Eclipse pour le développement, alors vous pouvez installer les plugins eGit et Mylyn ainsi que le connecteur GitHub pour Mylyn. Eclipse peut alors automatiquement suivre le problème sur lequel vous travaillez et remplir automatiquement le message de validation , y compris le numéro du problème, comme indiqué dans toutes les autres réponses.

Pour plus de détails sur cette configuration, voir http://wiki.Eclipse.org/EGit/GitHub/UserGuide

4
Bananeweizen

L’un de mes premiers projets en tant que programmeur a été une gemme appelée diligence qui (entre autres choses) permettait l’ajout automatique d’un Le numéro d'édition de github à chaque message de validation d'une branche, ce qui fait partie de la question à laquelle on n'a pas vraiment répondu.

Essentiellement, lors de la création d'une branche, vous utiliseriez une commande personnalisée (quelque chose comme stagecoach -b <branch_name> -g <issue_number>), et le numéro du problème serait alors attribué à cette branche dans un fichier yml. Il y avait alors un crochet de validation qui ajoutait automatiquement le numéro d'émission au message de validation.

Je ne le recommanderais pas pour une utilisation en production car, à l'époque, je ne programmais que depuis quelques mois et je ne le maintiens plus, mais cela pourrait intéresser quelqu'un.

3
omnikron