Rozpocznij wiadomość git commit ze znakiem hash (#)

Git traktuje wiersze rozpoczynające się od #jako wiersze komentarza podczas zatwierdzania. jest to bardzo denerwujące podczas pracy z systemem śledzenia biletów i próby wpisania numeru biletu na początku linii, np.

#123 salt hashed passwords

git po prostu usunie wiersz z komunikatu zatwierdzenia. czy jest jakiś sposób na ucieczkę od skrótu? próbowałem \i !, ale nic nie działa. białe znaki wcześniej #są zachowywane, więc nie są również działającym rozwiązaniem problemu.

To zachowanie jest częścią git commitdomyślnego zachowania „czyszczenia”. Jeśli chcesz, aby linie zaczynały się od #, możesz użyć alternatywnego trybu czyszczenia.

Na przykład

git commit --cleanup=whitespace

Jeśli to zrobisz, musisz uważać, aby usunąć wszystkie #wiersze, których nie chcesz pojawiać się w zatwierdzeniu.

Zauważ, że od git1.8.2 (luty 2013) możesz użyć innego znaku niż „ #” w komentarzowym wierszu w komunikacie zatwierdzenia.

Dzięki temu możesz użyć „ #” jako numeru referencyjnego błędu.

Różne linie „podpowiedzi”, które Git podaje, gdy prosi użytkownika o edycję wiadomości w edytorze, są komentowane za pomocą „# domyślnie ”.

core.commentCharZmienna konfiguracja może być używany, aby dostosować ten „ #” na inny charakter.

Teoretycznie można umieścićcore.commentChar słowo (wiele znaków), ale git 2.0.x / 2.1 będzie bardziej restrykcyjne (Q3 2014).

Zobacz commit 50b54fd autor: Nguyễn Thái Ngọc Duy ( pclouds) :

config: bądź surowy na core.commentChar

Nie obsługujemy komentarzy ciągów (przynajmniej jeszcze nie). Wielobajtowe kodowanie znaków może być również źle interpretowane.

Test z dwoma przecinkami został zaktualizowany, ponieważ narusza to. Został dodany wraz z łatką wprowadzoną core.commentCharw eff80a9 (Zezwól na niestandardowy „komentarz char” - 16.01.2013). Nie jest dla mnie jasne, dlaczego takie zachowanie jest pożądane.

git 2.0.x / 2.1 (III kwartał 2014) doda automatyczny wybór dla core.commentChar:
Zobacz commit 84c9dc2

Kiedy core.commentCharjest „ auto”, znak komentarza zaczyna się od „# ” jak domyślnie, ale jeśli jest już w przygotowanej wiadomości, znajdź inny znak w małym podzbiorze. To powinno powstrzymać niespodzianki, ponieważ git niespodziewanie usuwa niektóre linie.

Pamiętaj, że git nie jest wystarczająco inteligentny, aby rozpoznać #znak komentarza w niestandardowych szablonach i przekonwertować go, jeśli końcowy znak komentarza jest inny.
Uważa linie „#” w niestandardowych szablonach za część komunikatu zatwierdzenia. Więc nie używaj tego z niestandardowymi szablonami.

Lista znaków kandydujących do „auto” to:

# ; @ ! $ % ^ & | :

Oznacza to, że takie polecenie git commit -m '#1 fixed issue'automatycznie przełączy zmienną commentChar na „ ;”, ponieważ „ #” zostało użyte w komunikacie zatwierdzenia.

Odpowiedzi tutaj są dobre i szczegółowe, ale dla git noob, takiego jak ja, dostosowywanie opcji konfiguracji git nie jest tak oczywiste. Oto przykład, aby zmienić #na ;znaki komentarza:

git config core.commentChar ";"

To wszystko, co musisz zrobić.

Możesz użyć opcji wiersza poleceń -m:

git commit -m "#123 fixed"

Jeśli wykonujesz interaktywny rebase, to kiedy zapiszesz wiadomość zatwierdzenia bez niczego (ponieważ #na początku zrobił z niej komentarz i dlatego został zignorowany), git pokaże ci, co zrobić:

Aborting commit due to empty commit message.
Could not amend commit after successfully picking 5e9159d9ce3a5c3c87a4fb7932fda4e53c7891db... 123 salt hashed passwords
This is most likely due to an empty commit message, or the pre-commit hook
failed. If the pre-commit hook failed, you may need to resolve the issue before
you are able to reword the commit.
You can amend the commit now, with

        git commit --amend

Once you are satisfied with your changes, run

        git rebase --continue

Więc po prostu popraw wiadomość:

git commit --amend -m "#123 salt hashed passwords"

i kontynuuj rebase:

git rebase --continue

git commit --cleanup=scissorsnależy użyć. Został dodany do Git v2.0.0 2014.05.21

z git commit --help

--cleanup=<mode>
  scissors
    Same as whitespace, except that everything from (and including) the line
    "# ------------------------ >8 ------------------------" is truncated if the message
    is to be edited. "#" can be customized with core.commentChar.

Użyj innego prefiksu dla numeru biletu. Lub wstaw słowo do numeru biletu, na przykład „Bug # 42”. Lub wstaw pojedynczy znak spacji do linii; jeśli chcesz usunąć ten biały znak, możesz do tego dodać hak zatwierdzania.

Osobiście wolałbym, aby tego rodzaju manipulowanie wiadomościami zatwierdzającymi nie było wykonywane przez hak, ponieważ może być bardzo irytujące, gdy uruchamia się, gdy tego nie chcesz. Najłatwiejszym rozwiązaniem jest ponowne przemyślenie problemu.

Wszystkie moje zobowiązania zaczynają się od, #issueNumberwięc umieściłem ten bojler na moim vim .git/hooks/commit-msg:

NAME=$(git branch | grep '*' | sed 's/* //') 
echo "$NAME"' '$(cat "$1") > "$1"

Załóżmy więc, że mamy gałąź #15i wysyłamy komunikat zatwierdzenia add new awesome feature. Przy takim podejściu pojawi się komunikat końcowego zatwierdzenia #15 add new awesome feature.