Git Hooks verstehen

Willkommen bei Git Hooks! Git Hooks sind leistungsstarke, anpassbare Skripte, die Git automatisch vor oder nach Ereignissen wie Commits, Pushes oder dem Empfangen gepushter Commits ausführt.

Sie können sie sich als automatisierte Prüfungen oder Aktionen in Ihrem Git-Workflow vorstellen. Sie helfen dabei, Projektstandards durchzusetzen, Aufgaben zu automatisieren und andere Systeme zu integrieren.

Jedes Git-Repository enthält ein Verzeichnis .git/hooks. Darin finden Sie Beispielskripte für Hooks (die normalerweise mit .sample enden).

Um einen Hook zu aktivieren, entfernen Sie einfach die Erweiterung .sample und machen die Datei ausführbar. Git führt ihn dann zum passenden Zeitpunkt aus.

• Speicherort: .git/hooks/
• Dateien: Shell-Skripte (Bash, Python, Ruby usw.)
• Aktivierung: Umbenennen und ausführbar machen

Git Hooks werden je nach ihrem Ausführungsort in zwei Haupttypen unterteilt:

• Clientseitige Hooks: Sie werden auf Ihrem lokalen Rechner ausgeführt (z. B. vor einem Commit oder Rebase). Sie dienen der Automatisierung Ihres persönlichen Workflows und der Durchsetzung lokaler Richtlinien.
• Serverseitige Hooks: Sie werden auf dem entfernten Git-Server ausgeführt (z. B. wenn Sie Code in ein gemeinsam genutztes Repository pushen). Sie setzen projektweite Richtlinien für alle Beteiligten durch.

Der Hook pre-commit ist einer der häufigsten clientseitigen Hooks. Er wird *vor* der offiziellen Erstellung eines Commits durch Git ausgeführt.

Wenn das Skript pre-commit mit einem Status ungleich null beendet wird, bricht Git den Commit ab. Das eignet sich ideal für Aufgaben wie:

• Code-Linting (Prüfen auf Stilfehler)
• Ausführen von Unit-Tests
• Prüfen auf große Dateien oder vertrauliche Daten

Der Hook commit-msg wird *nach* der Eingabe Ihrer Commit-Nachricht, aber *vor* dem Abschluss des Commits ausgeführt.

Dieser Hook ist nützlich, um sicherzustellen, dass Ihre Commit-Nachrichten bestimmten Konventionen oder Formaten entsprechen. Er kann beispielsweise prüfen, ob:

• Die Nachricht mit einer Ticket-ID beginnt (z. B. [JIRA-123])
• Die Nachrichtenlänge innerhalb der festgelegten Grenzen liegt
• Bestimmte Schlüsselwörter vorhanden sind oder fehlen

Der Hook post-commit wird *unmittelbar nach* der erfolgreichen Erstellung eines Commits ausgeführt.

Im Gegensatz zu pre-commit oder commit-msg kann dieser Hook das Ergebnis des Commits nicht mehr ändern. Er wird häufig für Benachrichtigungen oder Integrationen verwendet, zum Beispiel:

• Teammitglieder benachrichtigen
• Ein Projektmanagement-Tool aktualisieren
• Einen Continuous-Integration-(CI-)Build auslösen (obwohl dies häufiger mit serverseitigen Hooks geschieht)

Bei serverseitigen Hooks wird pre-receive ausgeführt, bevor Referenzen wie Branches oder Tags im Remote-Repository aktualisiert werden.

Dieser Hook eignet sich besonders, um wichtige Richtlinien für das Repository durchzusetzen, zum Beispiel:

• Direkte Pushes in den Branch main verhindern
• Sicherstellen, dass alle Commits signiert sind
• Die Identität des Committers überprüfen

Wenn dieser Hook mit einem Status ungleich null beendet wird, wird der gesamte Push abgelehnt.

Der Hook post-receive wird ausgeführt, nachdem ein Push die Referenzen im Remote-Repository erfolgreich aktualisiert hat.

Ähnlich wie post-commit kann dieser Hook den Push nicht ablehnen. Er wird häufig verwendet für:

• Das Auslösen von CI/CD-Pipelines
• Das Aktualisieren externer Issue-Tracker
• Das Senden von E-Mail-Benachrichtigungen an das Team
• Das Bereitstellen von Code in einer Staging-Umgebung

Um einen Hook zu erstellen, legen Sie einfach eine Datei mit dem Namen des Hooks (z. B. pre-commit) in Ihrem Verzeichnis .git/hooks/ an. Erstellen wir einen ganz einfachen Hook:

Nachdem Sie Ihr Hook-Skript erstellt haben, müssen Sie es ausführbar machen. Andernfalls führt Git es nicht aus. Verwenden Sie dazu den Befehl chmod in Ihrem Terminal:

chmod +x .git/hooks/pre-commit

Ab jetzt führt Git dieses Skript jedes Mal aus, wenn Sie einen Commit erstellen!

Git-Hooks werden zu bestimmten Zeitpunkten in Ihrem Workflow ausgeführt. Wenn Sie den Zeitpunkt verstehen, können Sie sie gezielt einsetzen.

Sie haben den ersten Schritt in die leistungsstarke Welt der Git-Hooks gemacht!

• Git-Hooks sind Skripte, die Aktionen während Git-Ereignissen automatisieren.
• Sie befinden sich im Verzeichnis .git/hooks/ Ihres Repositorys.
• Hooks sind entweder clientseitig (auf dem lokalen Rechner) oder serverseitig (im Remote-Repository).
• Wichtige Hooks wie pre-commit und pre-receive können Richtlinien durchsetzen, indem sie Vorgänge blockieren.
• Hooks wie post-commit und post-receive dienen Benachrichtigungen oder Integrationen nach einer Aktion.

Als Nächstes sehen wir uns die praktische Implementierung bestimmter Hooks anhand von Beispielen an!