Link do numeru problemu w GitHub w komunikacie zatwierdzenia

738

Czy w wiadomości można w jakiś sposób automatycznie umieścić link do numeru wydania GitHub git commit?

git github git-commit

— Mika Tuupola
źródło

Powiązane: Odsyłacze do wykazów w github

— Didier L

952

Wystarczy dołączyć #xxxwiadomość zatwierdzającą, aby odwołać się do problemu bez jego zamykania.

Dzięki nowym problemom GitHub 2.0 możesz użyć tych synonimów, aby odnieść się do problemu i zamknąć go (w komunikacie zatwierdzenia):

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

Można również zastąpić #xxxz gh-xxx.

Działa także odwoływanie się i zamykanie problemów między repozytoriami :

fixes user/repo#xxx

Sprawdź dokumentację dostępną w sekcji Pomoc.

— NARKOZ
źródło

4

Fix issue #xxxnie działa dla mnie, jakieś pomysły? Odwołuje się do problemu, ale go nie zamyka.

— Dennis

16

@Dennis usuń słowo „problem”

1

@JamesTomasino to możliwe - zauważyłem, że to nie działało dla mnie, gdy pracuję nad oddziałem o nazwie dev.

— Jon Cairns

1

W jakich sytuacjach należy zastosować każdą z nich?

— nilsi

1

Nie będę osobą, która przeniesie tę odpowiedź z 666 głosów na 667, ale było to BARDZO pomocne.

— jakeatwork

168

Jeśli chcesz połączyć się z problemem GitHub i zamknąć problem, możesz podać następujące wiersze w komunikacie Git zatwierdzenia:

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

(Dowolna z trzech będzie działać.) Pamiętaj, że spowoduje to link do problemu, a także zamknie go. Możesz dowiedzieć się więcej w tym poście na blogu (zacznij oglądać osadzony film około 1:40).

Nie jestem pewien, czy podobna składnia po prostu prowadzi do problemu bez jego zamykania.

— mipadi
źródło

31

Możesz po prostu użyć numeru problemu (na przykład # 456), który będzie łączył się z zadaniem bez jego zamykania.

— Matthieu Napoli,

9

Wybrałbym „gh-1” zamiast „# 1” po prostu dlatego, że nigdy nie wiadomo, czy repozytorium zostanie wyeksportowane / dublowane do innego miejsca niż github. Wtedy „numer 1” nie będzie miał większego sensu.

— huyz

2

@mipadi: czy konieczne jest podanie .po „Zamknięciu GH-1”? Czy rozróżniana jest również wielkość liter?

— Lekensteyn

1

@Lekensteyn: Nie sądzę, żeby ten okres był konieczny. Nie jestem pewien co do wielkości liter.

— mipadi

message (closes GH-28)działa dla mnie, nie jestem pewien, czy we wszystkim nie jest rozróżniana wielkość liter.

— Lekensteyn

64

Możesz również znaleźć repozytorium referencyjne:

githubuser/repository#xxx

xxx jest numerem wydania

— narkeeso
źródło

62

github dodaje odniesienie do zatwierdzenia, jeśli zawiera #issuenbr (odkrył to przez przypadek).

— Henrik Lindberg
źródło

4

właśnie go przetestowałem, działa jak urok, dzięki ... to ten powinien zostać oznaczony jako poprawna odpowiedź ...

— opensas

14

na swoim blogu napisali o nowych problemach w wersji 2.0 https://github.blog/2011-04-09-issues-2-0-the-next-generation/

synonimy obejmują

naprawia #xxx
naprawiono #xxx
napraw #xxx
zamyka #xxx
zamknij #xxx
zamknięte #xxx

użycie dowolnego słowa kluczowego w komunikacie zatwierdzenia sprawi, że twoje zatwierdzenie zostanie wymienione lub zamknie problem.

— Xero
źródło

To było już na mojej liście, nie sądzę, aby rozróżniały wielkość liter.

— xero

4

Podobnie jak w przypadku innych odpowiedzi: jeśli nawet nie chcesz napisać komunikatu zatwierdzenia z numerem problemu i używasz Eclipse do programowania, możesz zainstalować wtyczki eGit i Mylyn, a także złącze GitHub dla Mylyn. Eclipse może następnie automatycznie śledzić problem, nad którym pracujesz, i automatycznie wypełniać komunikat zatwierdzenia , w tym numer problemu, jak pokazano we wszystkich pozostałych odpowiedziach.

Aby uzyskać więcej informacji na temat tej konfiguracji, zobacz http://wiki.eclipse.org/EGit/GitHub/UserGuide

— Bananeweizen
źródło

4

Aby połączyć numer problemu z komunikatem zatwierdzenia, należy dodać: #issue_numberw komunikacie git commit.

Przykład Commit Message od Udacity Git Przewodnik po stylu Commit Message

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

Możesz także odwoływać się do repozytoriów:

githubuser/repository#issue_number

— Suhas Srivats Subburathinam
źródło

Nie ma sensu (a właściwie mnie denerwuje), że używają „feat” jako skrótu „funkcji”, zwłaszcza gdy jednocześnie używają „refaktora”, który jest nawet dłuższy niż „funkcja”.

— Michel Jung,

@MichelJung możesz argumentować, że featjest używany częściej niż refactor, nie ma też oczywistego skrótu refactor( refmoże oznaczać odniesienie, rfjest zbyt niejasny itp.).

— Chris Kraszewski,

3

Jednym z moich pierwszych projektów jako programisty był klejnot zwany dyliżansiem, który (między innymi) umożliwiał automatyczne dodawanie numeru wydania github do każdej wiadomości zatwierdzenia w gałęzi, która jest częścią pytania, na które tak naprawdę nie udzielono odpowiedzi .

Zasadniczo podczas tworzenia gałęzi stagecoach -b <branch_name> -g <issue_number>użyłbyś niestandardowego polecenia (coś w stylu ), a numer sprawy zostałby przypisany do tej gałęzi w pliku yml. Był wtedy hak zatwierdzania, który automatycznie dołączał numer wydania do wiadomości zatwierdzenia.

Nie polecałbym tego do użytku produkcyjnego, ponieważ w tym czasie programowałem tylko kilka miesięcy i już go nie utrzymuję, ale może być dla kogoś interesujący.

— omnikron
źródło

Myślę, że twoja odpowiedź próbuje odpowiedzieć na dokładne pytanie z PO, tzn. „Sposób na automatyczne dodanie linku do problemu w zatwierdzeniu”. Wszystkie pozostałe odpowiedzi zależą od zapamiętania przez programistę „Poprawek #, Rozwiązanych # ... itd.” fraza do zatwierdzenia, a to nie nastąpi za każdym razem, gdy ją znamy. Upvoting.

— demisx 11.04.16