Was sind Webhooks im CI/CD-Prozess?

Webhooks in CI/CD sind automatisierte HTTP POST-Anfragen, die von einer Anwendung an eine andere gesendet werden, wenn ein bestimmtes Ereignis eintritt.

Im Kontext von CI/CD fungieren sie als Trigger. Zum Beispiel sendet bei einem Push-Ereignis in einem Git-Repository der Webhook eine Benachrichtigung an das CI/CD-System (Jenkins, GitLab CI, GitHub Actions usw.). Dieses System startet nach Erhalt der Benachrichtigung automatisch eine Pipeline (Build, Test, Deployment).

Hauptkomponenten:

• Ereignisquelle: System, in dem das Ereignis stattfindet (z.B. Git-Repository).
• URI des Webhooks: URL-Adresse, an die die HTTP POST-Anfrage gesendet wird. Diese Adresse gehört zum empfangenden System (CI/CD).
• Payload: Daten über das Ereignis, die im Body der HTTP POST-Anfrage übertragen werden (z.B. Commit-Informationen, Branch).
• Empfangendes System: Das CI/CD-System, das den Webhook verarbeitet und Aktionen initiiert.

Vorteile der Nutzung:

• Automatisierung: Verhindert manuelle Prozesse.
• Reaktivität: Der Pipeline-Start erfolgt sofort nach dem Ereignis, was eine schnellere Rückmeldung gewährleistet.
• Geringe Belastung: Das empfangende System muss den Ursprung nicht ständig abfragen (Polling).

Beispiel für die Arbeit mit GitHub Actions:

1. Im Repository auf GitHub wird ein Webhook hinzugefügt, der auf den Endpoint von GitHub Actions zeigt.
2. Der Entwickler führt git push aus.
3. GitHub erkennt das push-Ereignis und sendet eine HTTP POST-Anfrage (Webhook) an den angegebenen Endpoint von GitHub Actions.
4. GitHub Actions empfängt den Webhook, analysiert das Payload und startet den entsprechenden Workflow.

# Beispiel-Workflow in GitHub Actions, der bei push ausgelöst wird

name: CI Pipeline

on:
  push:
    branches:
      - main # Wird bei push auf den Branch main ausgelöst

jobs:
  build-and-test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2 # Repository klonen

      - name: Setup Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '14'

      - name: Install dependencies
        run: npm ci

      - name: Run tests
        run: npm test