Poznajemy Git Hooks

Witamy w świecie hooków Git! Hooki Git to potężne, konfigurowalne skrypty, które Git wykonuje automatycznie przed zdarzeniami takimi jak commitowanie, wypychanie lub odbieranie wypchniętych commitów albo po tych zdarzeniach.

Można myśleć o nich jak o automatycznych punktach kontrolnych lub działaniach w procesie pracy z Gitem. Pomagają egzekwować standardy projektu, automatyzować zadania i integrować się z innymi systemami.

Każde repozytorium Git zawiera katalog .git/hooks. W środku znajdują się przykładowe skrypty hooków (zwykle kończące się rozszerzeniem .sample).

Aby aktywować hook, wystarczy usunąć rozszerzenie .sample i nadać plikowi uprawnienia do wykonywania. Git będzie go wtedy uruchamiać w odpowiednim momencie.

• Lokalizacja: .git/hooks/
• Pliki: skrypty powłoki (Bash, Python, Ruby itd.)
• Aktywacja: zmiana nazwy i nadanie uprawnień do wykonywania

Hooki Git dzielą się na dwa główne typy zależnie od miejsca wykonywania:

• Hooki po stronie klienta: uruchamiają się na lokalnym komputerze (np. przed wykonaniem commita lub rebase). Służą do automatyzacji osobistego procesu pracy i egzekwowania lokalnych zasad.
• Hooki po stronie serwera: uruchamiają się na zdalnym serwerze Git (np. podczas wypychania kodu do współdzielonego repozytorium). Egzekwują zasady obowiązujące w całym projekcie.

Hook pre-commit jest jednym z najczęściej używanych hooków po stronie klienta. Uruchamia się *przed* oficjalnym utworzeniem commita przez Git.

Jeśli skrypt pre-commit zakończy działanie ze statusem różnym od zera, Git anuluje commit. Doskonale nadaje się to do zadań takich jak:

• lintowanie kodu (sprawdzanie błędów stylu)
• uruchamianie testów jednostkowych
• sprawdzanie obecności dużych plików lub poufnych danych

Hook commit-msg uruchamia się *po* wprowadzeniu komunikatu commita, ale *przed* jego finalizacją.

Hook ten pomaga zagwarantować, że komunikaty commitów są zgodne z określonymi konwencjami lub formatami. Może na przykład sprawdzać, czy:

• komunikat zaczyna się od identyfikatora zadania (np. [JIRA-123])
• długość komunikatu mieści się w określonych limitach
• zawiera określone słowa kluczowe lub ich nie zawiera

Hook post-commit uruchamia się *natychmiast po* pomyślnym utworzeniu commita.

W przeciwieństwie do pre-commit i commit-msg hook ten nie może zmienić rezultatu commita. Często służy do wysyłania powiadomień lub integracji, na przykład do:

• powiadamiania członków zespołu
• aktualizowania narzędzia do zarządzania projektem
• uruchamiania kompilacji w ramach ciągłej integracji (CI), choć częściej wykorzystuje się do tego hooki po stronie serwera

Przechodząc do hooków po stronie serwera, pre-receive jest wykonywany *przed* zaktualizowaniem jakichkolwiek referencji (takich jak gałęzie lub tagi) w zdalnym repozytorium.

Ten hook pozwala skutecznie egzekwować najważniejsze zasady repozytorium, takie jak:

• Zapobieganie bezpośredniemu wypychaniu zmian do gałęzi main
• Wymaganie podpisywania wszystkich commitów
• Weryfikowanie tożsamości autora commita

Jeśli ten hook zakończy działanie z niezerowym kodem wyjścia, cała operacja push zostanie odrzucona.

Hook post-receive jest uruchamiany *po* pomyślnym zaktualizowaniu referencji w zdalnym repozytorium przez operację push.

Podobnie jak post-commit, ten hook nie może odrzucić operacji push. Jest on często używany do:

• Uruchamiania potoków CI/CD
• Aktualizowania zewnętrznych systemów śledzenia zgłoszeń
• Wysyłania powiadomień e-mail do zespołu
• Wdrażania kodu w środowisku testowym

Aby utworzyć hook, wystarczy utworzyć plik o nazwie hooka (np. pre-commit) w katalogu .git/hooks/. Utwórzmy bardzo prosty hook:

Po utworzeniu skryptu hooka trzeba nadać mu uprawnienia do wykonywania. W przeciwnym razie Git go nie uruchomi. Użyj w terminalu polecenia chmod:

chmod +x .git/hooks/pre-commit

Od tej pory za każdym razem, gdy spróbujesz wykonać commit, Git uruchomi ten skrypt!

Hooki Git są uruchamiane w określonych momentach przepływu pracy. Zrozumienie tego harmonogramu jest kluczowe, aby skutecznie z nich korzystać.

Właśnie stawiasz pierwszy krok w potężnym świecie hooków Git!

• Hooki Git to skrypty automatyzujące działania podczas zdarzeń w Git.
• Znajdują się w katalogu .git/hooks/ repozytorium.
• Hooki dzielą się na klientowe (uruchamiane na komputerze lokalnym) i serwerowe (uruchamiane w zdalnym repozytorium).
• Najważniejsze hooki, takie jak pre-commit i pre-receive, mogą egzekwować zasady, blokując operacje.
• Hooki takie jak post-commit i post-receive służą do wysyłania powiadomień lub integracji po wykonaniu operacji.

W następnej części zajmiemy się praktycznymi przykładami implementacji konkretnych hooków!