Zum Inhalt springen
Trainingslager IT-Trainingslager

Tag 1: Der erste Workflow

Ziel: Einen Workflow schreiben, der bei jedem Push die Tests von notes-api ausführt, den Lauf mit gh verfolgen und einen roten Lauf lesen lernen. · Dauer: ca. 60 min · Voraussetzung: Tag 0

Briefing

  • Ein Workflow besteht aus Jobs, ein Job aus Steps. Jeder Job läuft auf einem eigenen, frischen Runner – Dateien aus einem Job gibt es im nächsten nicht.
  • Ein Step ist entweder ein Befehl (run:) oder eine fertige Action (uses:). actions/checkout holt den Code, actions/setup-go installiert Go.
  • on: legt fest, wann der Workflow startet. Für den Anfang: bei jedem push.
 .github/workflows/ci.yml
   on: push
   jobs:
     test:                 ─► Runner ubuntu-24.04 (frisch, nach dem Lauf weg)
       steps:
         checkout          ─► Code aus dem Repository
         setup-go          ─► Go in der Version aus go.mod
         go test ./...     ─► Exit 0 = grün, sonst rot

Drill 1: Die Workflow-Datei

cd ~/gha-lab/notes-actions
mkdir -p .github/workflows
cat > .github/workflows/ci.yml <<'EOF'
name: ci
on: push

jobs:
  test:
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v7
      - uses: actions/setup-go@v7
        with:
          go-version-file: go.mod
      - run: go test ./...
EOF
git add .github
git commit -qm "ci: Tests bei jedem Push"
git push -q
  • runs-on: ubuntu-24.04 wählt einen Runner von GitHub mit genau diesem Image. ubuntu-latest ginge auch, wechselt aber irgendwann ohne Ankündigung.
  • @v7 ist die Hauptversion der Action. Ab Tag 9 pinnst du Actions genauer.
  • go-version-file: go.mod nimmt die Go-Version aus dem Projekt – eine Stelle weniger, die man vergessen kann.

Fortschritt speichern? Kostenlos registrieren

Drill 2: Den Lauf verfolgen

gh run list --limit 1

Erwartet (ID, Dauer und Zeit weichen ab):

STATUS  TITLE                    WORKFLOW  BRANCH  EVENT  ID           ELAPSED  AGE
*       ci: Tests bei jedem Push ci        main    push   41607177389  7s       now

* heißt: läuft noch. Steht dort noch nichts, warte ein paar Sekunden – GitHub braucht einen Moment, bis der Lauf angelegt ist. gh run watch folgt dem Lauf bis zum Ende. Setze für <ID> die Zahl aus der Spalte ID ein:

gh run watch --exit-status <ID>

gh run watch frischt die Anzeige alle drei Sekunden auf. Am Ende steht da (gekürzt):

✓ main ci · 41607177389
Triggered via push less than a minute ago

JOBS
✓ test in 29s (ID 125819805658)
  ✓ Set up job
  ✓ Run actions/checkout@v7
  ✓ Run actions/setup-go@v7
  ✓ Run go test ./...
  ✓ Post Run actions/setup-go@v7
  ✓ Post Run actions/checkout@v7
  ✓ Complete job
  • Ohne ID fragt gh run watch interaktiv nach dem Lauf. Mit ID ist klar, welchen du meinst – und es funktioniert auch in Skripten.
  • --exit-status lässt den Befehl mit dem Ergebnis des Laufs enden: 0 bei grün.

Fortschritt speichern? Kostenlos registrieren

Drill 3: Logs lesen

gh run view <ID> --log | grep -E 'shell:|ok  '

Erwartet (Zeitstempel gekürzt):

test    Run go test ./...   2026-11-03T08:57:55Z shell: /usr/bin/bash -e {0}
test    Run go test ./...   2026-11-03T08:58:08Z ok     example.com/notes-api   0.044s

--log liefert das ganze Protokoll, grep holt die zwei interessanten Zeilen heraus. Jede Zeile beginnt mit Job und Step. shell: /usr/bin/bash -e {0} zeigt, wie der Runner run: ausführt: in Bash mit -e – der erste fehlerhafte Befehl beendet den Step.

Fortschritt speichern? Kostenlos registrieren

Drill 4: Ein roter Lauf

Ein Test soll scheitern:

sed -i 's/StatusCreated/StatusAccepted/' main_test.go
git commit -qam "Test kaputt"
git push -q
gh run list --limit 1

Mit der neuen ID:

gh run watch --exit-status <ID>; echo "Exit: $?"

Erwartet (gekürzt):

X main ci · 41607262782
Triggered via push less than a minute ago

JOBS
X test in 12s (ID 125820099540)
  ✓ Set up job
  ✓ Run actions/checkout@v7
  ✓ Run actions/setup-go@v7
  X Run go test ./...
  - Post Run actions/setup-go@v7
  ✓ Post Run actions/checkout@v7
  ✓ Complete job

ANNOTATIONS
X Process completed with exit code 1.
test: .github#12

Exit: 1

Nur die fehlerhaften Zeilen:

gh run view <ID> --log-failed | grep -E 'FAIL|want' | head -3

Erwartet (Spalten davor gekürzt):

... --- FAIL: TestPostNotesRequiresKey (0.00s)
...     main_test.go:75: key "lab-api-key-123": status 201, want 202
... FAIL
  • - vor dem Post-Step von setup-go heißt: übersprungen. Nach einem roten Step laufen nur noch Aufräum-Steps, die das ausdrücklich verlangen.
  • Die Annotation zeigt die Ursache auch auf der Übersichtsseite im Browser.

--log-failed zeigt nur die Steps, die gescheitert sind – bei langen Logs der schnellste Weg zur Ursache. Reparieren:

git revert --no-edit HEAD >/dev/null
git push -q
gh run list --limit 1
gh run watch --exit-status <ID> >/dev/null; echo "Exit: $?"

Die zweite Zeile mit gh run watch tippst du erst, wenn du die neue ID aus gh run list kennst.

Erwartet:

Exit: 0

Fortschritt speichern? Kostenlos registrieren

Kontrollpunkt

gh run list --limit 3 --json conclusion,displayTitle --jq '.[]'

Erwartet:

{"conclusion":"success","displayTitle":"Revert \"Test kaputt\""}
{"conclusion":"failure","displayTitle":"Test kaputt"}
{"conclusion":"success","displayTitle":"ci: Tests bei jedem Push"}
head -2 .github/workflows/ci.yml

Erwartet:

name: ci
on: push

Challenge

Ergänze den Job um einen Step go vet ./... vor den Tests. Er soll im Log einen eigenen Namen „Statische Prüfung“ tragen.

Hinweis: Jeder Step kann name: haben.

Lösung

cat > .github/workflows/ci.yml <<'EOF'
name: ci
on: push

jobs:
  test:
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v7
      - uses: actions/setup-go@v7
        with:
          go-version-file: go.mod
      - name: Statische Prüfung
        run: go vet ./...
      - run: go test ./...
EOF
git commit -qam "ci: go vet"
git push -q
gh run list --limit 1
gh run watch --exit-status <ID> >/dev/null
gh run view <ID> -v | grep -E 'Statische|go test'

gh run view -v zeigt die Steps jedes Jobs.

Erwartet:

  ✓ Statische Prüfung
  ✓ Run go test ./...

Fortschritt speichern? Kostenlos registrieren

Enterprise-Notiz

  • Workflows sind Code: Sie liegen im Repository, durchlaufen Reviews und haben eine Historie. Wer ci.yml ändert, ändert, was mit jedem Commit passiert – das verdient dieselbe Sorgfalt wie Anwendungscode.
  • Runner-Images wechseln: Auf ubuntu-24.04 aktualisiert GitHub die Werkzeuge wöchentlich. Was der Build braucht, installiert der Workflow selbst (setup-go), statt sich auf das Image zu verlassen.
  • Kosten: Öffentliche Repositorys laufen kostenlos, private haben ein Kontingent an Minuten. Große Teams sparen mit Caches (Tag 3) und eigenen Runnern (Tag 5, 14).