Collegamento al numero di problema su GitHub all'interno di un messaggio di commit

739

È in qualche modo possibile avere automaticamente un collegamento al numero di problema di GitHub nel git commitmessaggio?

git github git-commit

— Mika Tuupola
fonte

Correlati: riferimenti incrociati si impegna in github

— Didier L

954

Includi #xxxnel messaggio di commit per fare riferimento a un problema senza chiuderlo.

Con i nuovi problemi di GitHub 2.0 è possibile utilizzare questi sinonimi per fare riferimento a un problema e chiuderlo (nel messaggio di commit):

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

Puoi anche sostituire #xxxcon gh-xxx.

Funzionalità di riferimento e chiusura dei repository funzionano anche:

fixes user/repo#xxx

Consulta la documentazione disponibile nella sezione Guida.

— NARKOZ
fonte

4

Fix issue #xxxnon funziona per me, qualche idea? Fa riferimento al problema, ma non lo chiude.

— Dennis,

16

@Dennis rimuove la parola "problema"

1

@JamesTomasino è possibile - ho notato che questo non ha funzionato per me quando sto lavorando su una filiale chiamata dev.

— Jon Cairns,

1

In quali situazioni devono essere utilizzate ognuna?

— nilsi,

1

non sarò la persona che sposta questa risposta da 666 voti a 667, ma questo è stato MOLTO utile.

— jakeatwork

168

Se vuoi collegarti a un problema di GitHub e chiuderlo, puoi fornire le seguenti righe nel tuo messaggio di commit di Git:

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

(Ognuno dei tre funzionerà.) Nota che questo collegherà al problema e lo chiuderà . Puoi saperne di più in questo post del blog (inizia a guardare il video incorporato a circa 1:40).

Non sono sicuro se una sintassi simile si collegherà semplicemente a un problema senza chiuderlo.

— mipadi
fonte

31

Puoi semplicemente usare il numero del problema (ad esempio # 456) che collegherà all'attività senza chiuderlo.

— Matthieu Napoli,

9

Vorrei scegliere "gh-1" piuttosto che "# 1" semplicemente perché non si sa mai se il repository viene esportato / specchiato in un posto diverso da Github. Quindi, il "# 1" non avrà molto senso.

— huyz,

2

@mipadi: è necessario il .dopo "Chiude GH-1`? Inoltre, è sensibile al maiuscolo / minuscolo?

— Lekensteyn

1

@Lekensteyn: non credo che il periodo sia necessario. Non sono sicuro della distinzione tra maiuscole e minuscole.

— mipadi,

message (closes GH-28)funziona per me, non sono sicuro che tutto sia sensibile al maiuscolo / minuscolo.

— Lekensteyn,

64

È inoltre possibile incrociare i repository di riferimento:

githubuser/repository#xxx

xxx è il numero di emissione

— narkeeso
fonte

62

github aggiunge un riferimento al commit se contiene #issuenbr (scoperto per caso).

— Henrik Lindberg
fonte

4

appena provato, funziona come un incantesimo, grazie ... questo è quello che dovrebbe essere contrassegnato come risposta corretta ...

— apre il

14

hanno un bel commento sui nuovi numeri 2.0 sul loro blog https://github.blog/2011-04-09-issues-2-0-the-next-generation/

i sinonimi includono

correzioni #xxx
#xxx fisso
correzione #xxx
chiude #xxx
chiudi #xxx
#xxx chiuso

l'utilizzo di una delle parole chiave in un messaggio di commit renderà il tuo commit menzionato o chiuderà un problema.

— xero
fonte

Era già nella mia lista, non credo che facciano distinzione tra maiuscole e minuscole.

— xero,

4

Oltre alle altre risposte: se non vuoi nemmeno scrivere il messaggio di commit con il numero del problema e utilizzare Eclipse per lo sviluppo, puoi installare i plugin eGit e Mylyn e il connettore GitHub per Mylyn. Eclipse può quindi tracciare automaticamente il problema su cui si sta lavorando e riempire automaticamente il messaggio di commit , incluso il numero del problema, come mostrato in tutte le altre risposte.

Per maggiori dettagli su quella configurazione vedere http://wiki.eclipse.org/EGit/GitHub/UserGuide

— Bananeweizen
fonte

4

Per collegare il numero di problema al messaggio di commit, è necessario aggiungere: #issue_numbernel messaggio di commit git.

Esempio di messaggio Commit da Udacity Git Commit Message Style Guide

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

Puoi anche fare riferimento ai repository:

githubuser/repository#issue_number

— Suhas Srivats Subburathinam
fonte

Non ha senso (e in realtà mi infastidisce) che usano "feat" come abbreviazione di "feature", specialmente quando allo stesso tempo usano "refactor" che è anche più lungo di "feature".

— Michel Jung,

@MichelJung potresti argomentare che featviene usato più spesso di refactor, inoltre non esiste un'abbreviazione per refactor( refpotrebbe significare riferimento, rfè troppo poco chiaro, ecc.).

— Chris Kraszewski,

3

Uno dei miei primi progetti come programmatore è stato un gioiello chiamato diligenza che (tra le altre cose) ha permesso l' aggiunta automatica di un numero di emissione github a ogni messaggio di commit su un ramo, che è una parte della domanda a cui non è stata davvero data risposta .

In sostanza, durante la creazione di un ramo dovresti usare un comando personalizzato (qualcosa di simile stagecoach -b <branch_name> -g <issue_number>) e il numero di problema verrebbe assegnato a quel ramo in un file yml. C'è stato quindi un hook di commit che ha aggiunto automaticamente il numero di problema al messaggio di commit.

Non lo consiglierei per l'uso in produzione poiché all'epoca programmavo da pochi mesi e non lo manterrò più, ma potrebbe essere interessante per qualcuno.

— omnikron
fonte

Penso che la tua risposta stia cercando di rispondere alla domanda esatta dell'OP, ovvero "un modo per aggiungere automaticamente un collegamento al problema aggiunto nel commit". Tutte le altre risposte si basano sul programmatore che ricorda di aggiungere "Correzioni # ..., Risolto # ... ecc." frase per il commit e questo non accadrà ogni volta che lo conosciamo. Upvoting.

— Demisx