Zum Inhalt springen
Trainingslager IT-Trainingslager

Tag 15: Wettkampf

Ziel: Acht kaputte Workflows, acht typische Fehler aus dem Alltag. Finde jeweils die Ursache mit gh, Log und zizmor, behebe sie und beweise es mit einem grünen Lauf. · Dauer: ca. 90 min · Voraussetzung: Tag 0–14

Spielregeln

  • Jede Runde schreibt eine Datei .github/workflows/wk.yml, pusht sie und startet sie mit gh workflow run wk.yml.
  • Erst selbst suchen: gh run list, gh run view <ID> --log-failed, gh run view <ID> -v, zizmor -q --offline. Dann der Hinweis, dann die Lösung.
  • Eine Runde ist geschafft, wenn der Lauf grün ist und das Richtige tut.
  • Die ID eines Laufs: gh run list --workflow wk.yml --limit 1.
cd ~/gha-lab/notes-actions

Runde 1: Der Workflow, den es nicht gibt

cat > .github/workflows/wk.yml <<'EOF'
name: wk
on: workflow_dispatch
permissions:
  contents: read
jobs:
  r1:
    runs-on: ubuntu-24.04
    steps:
      - run: echo "Status: alles gut"
EOF
git add .github
git commit -qm "wk: Runde 1"
git push -q
gh workflow run wk.yml

Erwartet:

could not create workflow dispatch event: HTTP 422: Workflow does not have 'workflow
_dispatch' trigger (https://api.github.com/repos/<du>/notes-actions/actions/workflows/…)

Der Trigger steht doch da?

Hinweis: zizmor -q --offline .github/workflows/wk.yml. GitHub liest eine ungültige Datei gar nicht erst – und meldet das nur im Browser.

Lösung

zizmor -q --offline .github/workflows/wk.yml 2>&1 | head -1

Erwartet:

 WARN zizmor::registry::input: failed to parse input: mapping values are not allowed
in this context at line 9 column 26

echo "Status: alles gut" ist ein YAML-Wert ohne Anführungszeichen, und : darin macht ihn zu einem zweiten Schlüssel. Der ganze Befehl in Anführungszeichen:

cat > .github/workflows/wk.yml <<'EOF'
name: wk
on: workflow_dispatch
permissions:
  contents: read
jobs:
  r1:
    runs-on: ubuntu-24.04
    steps:
      - run: 'echo "Status: alles gut"'
EOF
git commit -qam "wk: Runde 1 gelöst"
git push -q
gh workflow run wk.yml

Erwartet:

https://github.com/<du>/notes-actions/actions/runs/41633565092

Im Log steht danach Status: alles gut.

Fortschritt speichern? Kostenlos registrieren

Runde 2: Die Bedingung, die immer gilt

cat > .github/workflows/wk.yml <<'EOF'
name: wk
on:
  workflow_dispatch:
    inputs:
      laut:
        type: boolean
        default: false
permissions:
  contents: read
jobs:
  r2:
    runs-on: ubuntu-24.04
    steps:
      - if: ${{ inputs.laut }} == 'true'
        run: echo "LAUT"
EOF
git commit -qam "wk: Runde 2"
git push -q
gh workflow run wk.yml -f laut=false

Prüfe, ob der Step lief:

gh run view <ID> -v | grep 'echo'

Erwartet – leider:

  ✓ Run echo "LAUT"

laut war false, der Step lief trotzdem.

Hinweis: Was wird aus ${{ inputs.laut }} == 'true', nachdem GitHub den Ausdruck eingesetzt hat?

Lösung

GitHub setzt ${{ inputs.laut }} ein und erhält den Text false == 'true'. Ein nicht leerer Text ist wahr. Der ganze Vergleich gehört in den Ausdruck – bei einem Boolean genügt der Wert selbst:

cat > .github/workflows/wk.yml <<'EOF'
name: wk
on:
  workflow_dispatch:
    inputs:
      laut:
        type: boolean
        default: false
permissions:
  contents: read
jobs:
  r2:
    runs-on: ubuntu-24.04
    steps:
      - if: inputs.laut
        run: echo "LAUT"
EOF
git commit -qam "wk: Runde 2 gelöst"
git push -q
gh workflow run wk.yml -f laut=false

Sobald der Lauf fertig ist, zeigt gh run view <ID> -v ein - vor Run echo "LAUT": übersprungen.

Fortschritt speichern? Kostenlos registrieren

Runde 3: Der leere Output

cat > .github/workflows/wk.yml <<'EOF'
name: wk
on: workflow_dispatch
permissions:
  contents: read
jobs:
  r3:
    runs-on: ubuntu-24.04
    steps:
      - id: v
        run: echo "version=1.2.3" >> "$GITHUB_OUTPUT"
      - env:
          VERSION: ${{ steps.v.outputs.versoin }}
        run: |
          echo "Version ist '$VERSION'"
          test -n "$VERSION"
EOF
git commit -qam "wk: Runde 3"
git push -q
gh workflow run wk.yml

Sobald der Lauf fertig ist:

gh run view <ID> --log-failed | grep -E "Z Version ist"

Erwartet:

r3  Run echo "Version ist '$VERSION'"   ... Version ist ''

Der Lauf ist rot – test -n hat zugeschlagen.

Hinweis: Ein unbekannter Output ist kein Fehler – nur leer.

Lösung

Tippfehler: versoin. Ausdrücke melden unbekannte Namen nicht, sie liefern einen leeren Text. test -n macht den Fehler sichtbar – ein guter Wächter für Werte, die nie leer sein dürfen.

sed -i 's/outputs.versoin/outputs.version/' .github/workflows/wk.yml
git commit -qam "wk: Runde 3 gelöst"
git push -q
gh workflow run wk.yml

Sobald der Lauf fertig ist, steht im Log Version ist '1.2.3'.

Fortschritt speichern? Kostenlos registrieren

Runde 4: Zu wenig Rechte

cat > .github/workflows/wk.yml <<'EOF'
name: wk
on: workflow_dispatch
permissions:
  contents: read
jobs:
  r4:
    runs-on: ubuntu-24.04
    steps:
      - env:
          GH_TOKEN: ${{ github.token }}
        run: gh label create "wk-$GITHUB_RUN_ID" --repo "$GITHUB_REPOSITORY"
EOF
git commit -qam "wk: Runde 4"
git push -q
gh workflow run wk.yml

Sobald der Lauf fertig ist:

gh run view <ID> --log-failed | grep -o 'HTTP 403.*'

Erwartet:

HTTP 403: Resource not accessible by integration (https://api.github.com/repos/<du>...

Ganz: …/repos/<du>/notes-actions/labels.

Hinweis: Resource not accessible by integration heißt: Das GITHUB_TOKEN darf das nicht.

Lösung

Labels gehören zu Issues. Der Job braucht issues: write – nur er, nicht der ganze Workflow:

cat > .github/workflows/wk.yml <<'EOF'
name: wk
on: workflow_dispatch
permissions:
  contents: read
jobs:
  r4:
    runs-on: ubuntu-24.04
    permissions:
      issues: write
    steps:
      - env:
          GH_TOKEN: ${{ github.token }}
        run: gh label create "wk-$GITHUB_RUN_ID" --repo "$GITHUB_REPOSITORY"
EOF
git commit -qam "wk: Runde 4 gelöst"
git push -q
gh workflow run wk.yml

Sobald der Lauf fertig ist:

gh label list --search wk-

Erwartet (die Zahl weicht ab):

Showing 1 of 1 label in <du>/notes-actions

NAME            DESCRIPTION  COLOR
wk-41633979173               #5319E7

Aufräumen: gh label delete wk-41633979173 --yes mit deiner Zahl.

Fortschritt speichern? Kostenlos registrieren

Runde 5: Grün, obwohl es scheitert

cat > .github/workflows/wk.yml <<'EOF'
name: wk
on: workflow_dispatch
permissions:
  contents: read
jobs:
  r5:
    runs-on: ubuntu-24.04
    steps:
      - run: |
          false | tee ergebnis.txt
          echo "Weiter nach dem Fehler"
EOF
git commit -qam "wk: Runde 5"
git push -q
gh workflow run wk.yml

Sobald der Lauf fertig ist:

gh run view <ID> --log | grep -E 'Z (shell|Weiter)'
gh run view <ID> --json conclusion --jq .conclusion

Erwartet:

r5  Run false | tee ergebnis.txt    ... shell: /usr/bin/bash -e {0}
r5  Run false | tee ergebnis.txt    ... Weiter nach dem Fehler
success

false ist gescheitert, der Step ist grün.

Hinweis: Achte auf die Zeile mit shell:. Was fehlt gegenüber einem Skript, das bei Fehlern in Pipes abbricht?

Lösung

Ohne shell: läuft run: mit bash -e. Der Exit-Code einer Pipe ist der des letzten Befehls – hier tee, und tee klappt. Mit shell: bash ergänzt GitHub -o pipefail:

cat > .github/workflows/wk.yml <<'EOF'
name: wk
on: workflow_dispatch
permissions:
  contents: read
jobs:
  r5:
    runs-on: ubuntu-24.04
    steps:
      - shell: bash
        run: |
          false | tee ergebnis.txt
          echo "Weiter nach dem Fehler"
EOF
git commit -qam "wk: Runde 5 gelöst"
git push -q
gh workflow run wk.yml

Sobald der Lauf fertig ist:

gh run view <ID> --log | grep -E 'Z (shell|Weiter)'
gh run view <ID> --json conclusion --jq .conclusion

Erwartet:

r5  Run false | tee ergebnis.txt    ... shell: /usr/bin/bash --noprofile --norc -e -o pi...
failure

Jetzt rot – richtig so. „Weiter nach dem Fehler“ erscheint nicht mehr. Für alle Steps eines Workflows: defaults: run: shell: bash auf oberster Ebene.

Fortschritt speichern? Kostenlos registrieren

Runde 6: Zwei Artefakte, ein Name

cat > .github/workflows/wk.yml <<'EOF'
name: wk
on: workflow_dispatch
permissions:
  contents: read
jobs:
  r6:
    strategy:
      matrix:
        teil: [a, b]
    runs-on: ubuntu-24.04
    steps:
      - run: echo "Teil ${{ matrix.teil }}" > teil-${{ matrix.teil }}.txt
      - uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
        with:
          name: teile
          path: teil-*.txt
  zusammen:
    needs: r6
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
        with:
          name: teile
      - run: cat teil-*.txt
EOF
git commit -qam "wk: Runde 6"
git push -q
gh workflow run wk.yml

Sobald der Lauf fertig ist:

gh run view <ID> --json conclusion --jq .conclusion
gh run view <ID> --log | grep -E 'zusammen.*Z Teil'

Erwartet:

success
zusammen    Run cat teil-*.txt  ... Teil b

Grün – aber Teil a fehlt.

Hinweis: gh api repos/{owner}/{repo}/actions/runs/<ID>/artifacts --jq '.artifacts[].name'.

Lösung

gh api repos/{owner}/{repo}/actions/runs/<ID>/artifacts --jq '.artifacts[].name'

Erwartet:

teile
teile

Beide Matrix-Jobs haben ein Artefakt namens teile hochgeladen – GitHub legt zwei an, ohne zu meckern. download-artifact mit name: teile holt nur eines davon. Jeder Job braucht einen eigenen Namen, und der Download holt alle passenden:

cat > .github/workflows/wk.yml <<'EOF'
name: wk
on: workflow_dispatch
permissions:
  contents: read
jobs:
  r6:
    strategy:
      matrix:
        teil: [a, b]
    runs-on: ubuntu-24.04
    steps:
      - run: echo "Teil ${{ matrix.teil }}" > teil-${{ matrix.teil }}.txt
      - uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
        with:
          name: teil-${{ matrix.teil }}
          path: teil-*.txt
  zusammen:
    needs: r6
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
        with:
          pattern: teil-*
          merge-multiple: true
      - run: cat teil-*.txt
EOF
git commit -qam "wk: Runde 6 gelöst"
git push -q
gh workflow run wk.yml

Sobald der Lauf fertig ist:

gh run view <ID> --log | grep -E 'zusammen.*Z Teil'

Erwartet:

zusammen    Run cat teil-*.txt  ... Teil a
zusammen    Run cat teil-*.txt  ... Teil b

Ältere Versionen von upload-artifact brachen beim zweiten gleichen Namen mit Conflict ab. Heute ist es still – darum lohnt ein Blick in die Artefaktliste.

Fortschritt speichern? Kostenlos registrieren

Runde 7: Die Action, die es nicht gibt

cat > .github/workflows/wk.yml <<'EOF'
name: wk
on: workflow_dispatch
permissions:
  contents: read
jobs:
  r7:
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b2 # v7.0.1
        with:
          persist-credentials: false
      - run: ls go.mod
EOF
git commit -qam "wk: Runde 7"
git push -q
gh workflow run wk.yml

Sobald der Lauf fertig ist:

gh run view <ID> --log | grep -o 'Unable to resolve action.*'

Erwartet:

Unable to resolve action `actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b2`,
unable to find version `3d3c42e5aac5ba805825da76410c181273ba90b2`

Hinweis: Vergleiche den SHA mit Tag 9.

Lösung

Das letzte Zeichen ist falsch: …ba90b2 statt …ba90b1. Einen SHA tippt niemand ab – hol ihn dir:

gh api repos/actions/checkout/commits/v7.0.1 --jq .sha
sed -i 's/ba90b2 # v7.0.1/ba90b1 # v7.0.1/' .github/workflows/wk.yml
git commit -qam "wk: Runde 7 gelöst"
git push -q
gh workflow run wk.yml

Erwartet:

3d3c42e5aac5ba805825da76410c181273ba90b1
https://github.com/<du>/notes-actions/actions/runs/41634532754

Sobald der Lauf fertig ist, steht im Log go.mod.

Fortschritt speichern? Kostenlos registrieren

Runde 8: Das Secret, das fehlt

cat > .github/workflows/wk.yml <<'EOF'
name: wk
on: workflow_dispatch
permissions:
  contents: read
jobs:
  r8:
    runs-on: ubuntu-24.04
    steps:
      - env:
          DEPLOY_TOKEN: ${{ secrets.DEPLOY_TOKEN }}
        run: |
          echo "Länge: ${#DEPLOY_TOKEN}"
          test -n "$DEPLOY_TOKEN"
EOF
git commit -qam "wk: Runde 8"
git push -q
gh workflow run wk.yml

Sobald der Lauf fertig ist:

gh run view <ID> --log | grep 'Z Länge'

Erwartet:

r8  Run echo "Länge: ${#DEPLOY_TOKEN}"  ... Länge: 0

Hinweis: gh secret list und gh secret list --env produktion.

Lösung

DEPLOY_TOKEN ist ein Secret des Environments produktion (Tag 10), kein Secret des Repositorys. Ein Job sieht es nur mit environment: produktion:

cat > .github/workflows/wk.yml <<'EOF'
name: wk
on: workflow_dispatch
permissions:
  contents: read
jobs:
  r8:
    runs-on: ubuntu-24.04
    environment: produktion
    steps:
      - env:
          DEPLOY_TOKEN: ${{ secrets.DEPLOY_TOKEN }}
        run: |
          echo "Länge: ${#DEPLOY_TOKEN}"
          test -n "$DEPLOY_TOKEN"
EOF
git commit -qam "wk: Runde 8 gelöst"
git push -q
gh workflow run wk.yml

Freigeben wie an Tag 10. Sobald der Lauf fertig ist, steht im Log Länge: 20.

Fehlende Secrets sind leer, kein Fehler – wie der Output in Runde 3. test -n fängt beides.

Fortschritt speichern? Kostenlos registrieren

Auswertung

Runde Fehler Werkzeug, das ihn zeigt
1 Ungültiges YAML zizmor, Browser
2 Vergleich außerhalb von ${{ }} gh run view -v
3 Tippfehler im Output-Namen test -n im Step
4 Fehlendes Recht --log-failed, HTTP 403
5 Pipe ohne pipefail Zeile shell: im Log
6 Artefakt-Name doppelt Artefaktliste per gh api
7 Falscher SHA Log, Unable to resolve action
8 Secret am falschen Ort test -n, gh secret list

Acht von acht? Dann räume auf:

git rm -q .github/workflows/wk.yml
git commit -qm "wk: Wettkampf beendet"
git push -q

Enterprise-Notiz

  • actionlint prüft Workflows auf Syntax, Ausdrücke und Shell-Fehler und hätte Runde 1, 2 und 3 schon vor dem Push gefunden. Zusammen mit zizmor gehört es in jeden Pull-Request, der .github/workflows/ ändert.
  • defaults.run.shell: bash auf oberster Ebene jedes Workflows verhindert Runde 5 überall.
  • Fehler sichtbar machen: Leere Werte, die nie leer sein dürfen, prüft ein Step mit test -n – lieber ein roter Lauf als ein Deployment mit leerer Version.