Zum Inhalt springen
Trainingslager IT-Trainingslager

Anhang B: Abschlussprüfung

Ziel: Nachweisen, dass du eine neue Anwendung allein end-to-end mit Renovate versorgst: Org-Preset, Bot-Config, Onboarding, Regeln, eigene Abhängigkeiten, Sicherheit und Fehlersuche. · Dauer: 120 min Praxis + 20 min Fragen · Voraussetzung: Tag 14

Regeln

  • Gelände wie nach Tag 14: check.sh alles ✔, Renovate 44.153.1, Forgejo 16.0.6. RENOVATE_GITHUB_COM_TOKEN ist gesetzt, sonst scheitern Aufgabe 5 und 6 (github-token-required, Tag 0).
  • Erlaubt: --help, Anhang A, docs.renovatebot.com, die Forgejo-API-Doku. Nicht erlaubt: Kapitel-Lösungen kopieren oder in code/anhang-b/loesung/ schauen.
  • Renovate startest du nur als renovate ohne Argumente in ~/renovate-lab/pruefung, also mit deiner config.js. Jede Repo-Config heißt renovate.json, liegt im Wurzelverzeichnis und geht erst nach renovate-config-validator auf main.
  • PRs mergen, Commit-Status setzen und Checkboxen haken nur per API als lab-admin. Keine Commits in renovate/*-Branches.
  • start.sh setzt alles zurück und leert ~/renovate-lab/pruefung. Das Skript bewertung.sh vergibt die Punkte, nicht dein Gefühl.
  • Bestanden: mindestens 70 von 100 Punkten und Aufgabe 6 (Sicherheit) voll.
source ~/renovate-lab/setup/env.sh
~/renovate-lab/setup/check.sh | grep ✘ || echo "Gelände ok"
export RENOVATE_GITHUB_COM_TOKEN=$(gh auth token)   # Pflicht für Aufgabe 5 und 6
~/renovate-lab/code/anhang-b/start.sh && cd ~/renovate-lab/pruefung

Erwartet:

Gelände ok
✔ billing/renovate-config, billing/billing-api, billing/billing-worker angelegt
✔ Ordner pruefung geleert

Die Prüfbefehle nutzen vier Kurzbefehle. Tipp sie einmal ab:

A=$FORGEJO/api/v1/repos/billing
api() { curl -sf -u "$ADMIN" -H 'Content-Type: application/json' "$@"; }
raw() { api "$FORGEJO/billing/$1/raw/branch/$2/$3"; }   # raw <repo> <branch> <datei>
prs() { api "$A/billing-api/pulls?state=${1:-open}&limit=50" | jq -r 'sort_by(.number)[]
  | "#\(.number) \(if .merged then "merged" else .state end) \(.head.label)"
    + " | \(.title)"'; }
dash() { api "$A/billing-api/issues?type=issues&state=open" | jq -r '.[]
  | select(.title == "Dependency Dashboard") | .body'; }

Die neue Anwendung heißt billing. start.sh hat in der Org billing angelegt:

Repo Inhalt Bot
renovate-config nur README.md Schreibrecht
billing-api npm (express 4.18.2, lodash, prettier), Dockerfile, Workflow Schreibrecht
billing-worker Go-Module, renovate.json mit Fehlern Schreibrecht

Das Dockerfile von billing-api startet mit FROM node:20.11.0-alpine und ARG KUBECTL_VERSION=v1.29.0, der Workflow nutzt actions/checkout@v3 und actions/setup-node@v3. Forgejo Actions ist im Repo aus (kein Runner, Tag 5). shop/shop-api aus den Tagen davor existiert weiter und gehört nicht zur Prüfung.

Teil 1: Praktische Prüfung

Die Aufgaben bauen aufeinander auf. Die Regeln aus Aufgabe 4 bis 8 schreibst du zusammen in die renovate.json von billing-api oder ins Preset, bevor du die Prüfbefehle ab Aufgabe 4 der Reihe nach ausführst. Die Zielversionen in den Ausgaben sind bei dir neuer.

Aufgabe 1: Org-Preset-Repo (10 Punkte)

billing/renovate-config bekommt eine default.json: Basis config:recommended, Zeitzone Europe/Berlin. Der Bot darf das Repo nur lesen (Tag 11). Die Regeln aus Aufgabe 6 darfst du hier oder im Repo ablegen.

curl -s -H "Authorization: token $RENOVATE_TOKEN" "$A/renovate-config" \
  | jq -c .permissions
raw renovate-config main default.json | jq -r .timezone

Erwartet:

{"admin":false,"push":false,"pull":true}
Europe/Berlin

Aufgabe 2: Globale config.js (10 Punkte)

Lege ~/renovate-lab/pruefung/config.js an: Forgejo, Token nur aus der Umgebung, autodiscover ausschließlich für billing/*. Der Onboarding-PR soll eine renovate.json vorschlagen, die nur local>billing/renovate-config erweitert (Tag 9).

renovate-config-validator config.js | tail -1
renovate --write-discovered-repos=repos.json >/dev/null 2>&1; cat repos.json; echo

Erwartet:

 INFO: Config validated successfully against 1 file(s)
["billing/billing-api","billing/billing-worker"]

shop/shop-api fehlt wegen des Filters, billing/renovate-config fehlt, weil der Bot dort nicht schreiben darf.

Aufgabe 3: Onboarding mit Org-Preset (5 Punkte)

Erster Lauf. Prüfe den Onboarding-PR von billing-api und merge ihn (Tag 1).

renovate > lauf-1.log 2>&1; grep -E 'Onboarding PR|invalid config' lauf-1.log
prs; raw billing-api renovate/configure renovate.json | jq -c .extends

Erwartet:

 INFO: Onboarding PR created (repository=billing/billing-api)
 WARN: Repository has invalid config (repository=billing/billing-worker)
#1 open renovate/configure | Configure Renovate
["local>billing/renovate-config"]

Die Warnung zu billing-worker ist Aufgabe 9.

Aufgabe 4: Gruppen, Schedule, Limits (15 Punkte)

Für billing-api gilt (Tag 4): höchstens 4 offene PRs, kein Stundenlimit. Alle devDependencies landen in der Gruppe dev-tools. Produktions-Abhängigkeiten (dependencies) dürfen nur montags von 0 bis 4 Uhr neue Branches bekommen, in der Zeitzone aus dem Preset.

LOG_LEVEL=debug renovate > lauf-2.log 2>&1; prs | cut -c1-88
dash | grep -E '^## Rate|unlimit-branch' | cut -c1-88

Erwartet:

#2 open renovate/npm-express-vulnerability | Update dependency express to v4.20.0 [SECUR
#3 open renovate/pin-dependencies | Pin dependencies
#4 open renovate/kubernetes-kubernetes-1.x | Update dependency kubernetes/kubernetes to
#5 open renovate/dev-tools | Update dependency prettier to v3.9.10
#6 open renovate/node-20.x | Update Node.js to v20.20.2
## Rate-Limited
 - [ ] <!-- unlimit-branch=renovate/actions-checkout-7.x -->Update actions/checkout acti
 - [ ] <!-- unlimit-branch=renovate/actions-setup-node-7.x -->Update actions/setup-node
 - [ ] <!-- unlimit-branch=renovate/node-24.x -->Update dependency node to v24

Vier normale PRs, die Majors warten als „Rate-Limited”. Der fünfte PR ist der Security-PR, der kein Limit kennt. Die Gruppe dev-tools enthält nur prettier, darum trägt der PR den Titel des einzelnen Updates.

Aufgabe 5: customManager für kubectl (10 Punkte)

Renovate soll ARG KUBECTL_VERSION im Dockerfile über die GitHub-Releases von kubernetes/kubernetes aktualisieren. Das Dockerfile bleibt unverändert, also ohne # renovate:-Kommentar (Tag 7).

raw billing-api renovate/kubernetes-kubernetes-1.x Dockerfile | grep '^ARG'

Erwartet:

ARG KUBECTL_VERSION=v1.37.1

Aufgabe 6: Sicherheit (15 Punkte, Pflicht)

Renovate gleicht die Abhängigkeiten mit OSV ab. Der Security-PR kommt trotz Schedule aus Aufgabe 4. Alle GitHub Actions werden per Digest gepinnt, der Tag bleibt als Kommentar lesbar. Merge danach Security-PR und Pin-PR (Tag 12).

grep 'Checking schedule' lauf-2.log \
  | grep -oE 'schedule=[^,]*|branch=renovate/[^)]*' | paste - - | head -2

Erwartet:

schedule=   branch=renovate/npm-express-vulnerability
schedule=at any time    branch=renovate/pin-dependencies

Der Security-Branch läuft mit leerem Schedule. Nach den beiden Merges:

prs all | grep -E 'SECURITY|Pin' | cut -c1-88
raw billing-api main .github/workflows/ci.yml | grep uses

Erwartet:

#2 merged renovate/npm-express-vulnerability | Update dependency express to v4.20.0 [SEC
#3 merged renovate/pin-dependencies | Pin dependencies
      - uses: actions/checkout@a37ce9120846195fa4ece8f58b268e6043cb2f26 # v3
      - uses: actions/setup-node@3235b876344d2a9aa001b8d1453c930bba69e610 # v3

Tipp: Schlägt ein Merge direkt nach dem vorigen fehl, prüft Forgejo noch die Mergebarkeit. Ein paar Sekunden warten und erneut senden.

Aufgabe 7: Automerge mit Status-Check (15 Punkte)

Renovate mergt Patches und Minor/Patch-Updates von devDependencies selbst, Majors nie. Gemergt wird nur bei grünem Commit-Status. Du spielst die CI: Setz per API ci/test auf success für den aktuellen Kopf von renovate/dev-tools und starte einen Lauf (Tag 5).

renovate > lauf-3.log 2>&1        # nach den Merges aus Aufgabe 6: Rebase
# ... hier Status setzen (und Aufgabe 8 erledigen) ...
renovate > lauf-4.log 2>&1; grep automerged lauf-4.log
prs all | grep -E 'dev-tools|Node'
n=$(prs all | awk '/dev-tools/ {print substr($1, 2)}')
api "$A/billing-api/pulls/$n" | jq -r .merged_by.login

Erwartet:

 INFO: PR automerged (repository=billing/billing-api, branch=renovate/dev-tools)
#5 merged renovate/dev-tools | Update dependency prettier to v3.9.10
#6 open renovate/node-20.x | Update Node.js to v20.20.2
renovate-bot

Setzt du den Status vor lauf-3, hängt er am alten Commit: Renovate rebased den Branch nach jedem Merge auf main, und der neue Kopf hat keinen Status.

Aufgabe 8: express-Major nur mit Freigabe (10 Punkte)

express 5 darf erst kommen, wenn jemand im Dependency Dashboard zustimmt. Erteile die Freigabe per API-Haken vor lauf-4 (Tag 14).

dash | grep approve-branch | cut -c1-88      # nach lauf-3
prs | grep express-5                         # nach lauf-4

Erwartet:

 - [ ] <!-- approve-branch=renovate/express-5.x -->Update dependency express to v5
#10 open renovate/express-5.x | Update dependency express to v5

Vor dem Merge des Security-PRs taucht express 5 nirgends auf (Wissensfrage 4).

Aufgabe 9: Fehlerdiagnose billing-worker (10 Punkte)

Die renovate.json von billing-worker enthält Fehler. Finde jeden davon und schreib jede Fehlermeldung als eigene Zeile in ~/renovate-lab/pruefung/diagnose.txt. Repariere die Config danach so, dass sie local>billing/renovate-config erweitert und gomodTidy behält (Tag 2, Tag 14).

api "$A/billing-worker/issues?type=issues&state=all" \
  | jq -r '.[] | "#\(.number) \(.state) \(.title)"'
api "$A/billing-worker/pulls" | jq -r '.[] | "#\(.number) \(.title)"'

Erwartet:

#4 open Dependency Dashboard
#1 closed Action Required: Fix Renovate Configuration
#3 Update module github.com/google/uuid to v1.6.0
#2 Update module github.com/pkg/errors to v0.9.1

Punkte

Aufgabe Punkte erreicht
1 Org-Preset-Repo 10
2 Globale config.js 10
3 Onboarding mit Org-Preset 5
4 Gruppen, Schedule, Limits 15
5 customManager für kubectl 10
6 Sicherheit (Pflicht) 15
7 Automerge mit Status-Check 15
8 express-Major nur mit Freigabe 10
9 Fehlerdiagnose billing-worker 10
Summe 100

Bewertungsskript

Das Skript liegt unter ~/renovate-lab/code/anhang-b/bewertung.sh. Es ändert nichts: Die aufgelöste Config holt es per --print-config=true --dry-run=extract (Tag 11), alles andere per API. Der Kopf:

#!/usr/bin/env bash
# bewertung.sh – wertet die praktische Abschlussprüfung aus (Anhang B)
# Aufruf: ~/renovate-lab/code/anhang-b/bewertung.sh   (Laufzeit unter 1 min)
LAB="${LAB:-$HOME/renovate-lab}"
source "$LAB/setup/env.sh"
P="$LAB/pruefung"; cd "$P" || exit 2
A="$FORGEJO/api/v1/repos/billing"
api() { curl -sf -u "$ADMIN" "$@"; }
raw() { api "$FORGEJO/billing/$1/raw/branch/$2/$3"; }       # raw <repo> <ref> <datei>
T=$(mktemp -d)
declare -a pts=(0 0 0 0 0 0 0 0 0 0)
pt() {  # pt <aufgabe> <punkte> <text> <befehl...>
  local a=$1 p=$2 t=$3; shift 3
  if "$@" >/dev/null 2>&1; then
    echo "✔ A$a $t (+$p)"; pts[a]=$((pts[a] + p))
  else
    echo "✘ A$a $t (0 von $p)"
  fi
}
# Aufgelöste Config und Laufergebnis je Repo, ohne etwas zu verändern
for r in billing-api billing-worker; do
  (cd "$T" && LOG_FORMAT=json renovate --print-config=true --dry-run=extract \
    "billing/$r" > "$T/$r.log" 2>&1)
  jq -c 'select(.msg == "Full resolved config and hostRules including presets")
    | .config' "$T/$r.log" > "$T/$r.cfg"
done

Danach folgen die Prüffunktionen und je Prüfung eine pt-Zeile, etwa:

pt 4 5 "Schedule für dependencies" rule '((.matchDepTypes // [])
  | index("dependencies")) and ((.schedule // []) | length > 0)'
pt 6 5 "Actions per Digest gepinnt" pinned ''
pt 7 6 "dev-tools von Renovate automatisch gemergt" automerged

Der Lauf im leeren Temp-Verzeichnis ist Absicht: Im Ordner pruefung würde Renovate deine config.js mit autodiscover laden, und Repo-Argumente sind dann kein Filter (Tag 9). Prüfungen auf die aufgelöste Config sind egal gegenüber dem Ablageort: Eine Regel zählt, ob sie im Preset oder in renovate.json steht.

~/renovate-lab/code/anhang-b/bewertung.sh

Erwartet bei voller Lösung (gekürzt):

✔ A1 default.json im Preset-Repo gültig (+4)
✔ A1 Bot liest das Preset-Repo nur (+3)
✔ A1 billing-api erbt timezone Europe/Berlin (+3)
...
✔ A6 Security-PR für express gemergt (+5)
✔ A6 Actions per Digest gepinnt (+5)
✔ A6 Tag als Kommentar hinter dem Digest (+2)
...
✔ A9 diagnose.txt nennt beide Fehler (+3)
Summe: 100 von 100 (Pflichtaufgabe 6: 15 von 15)
✔ BESTANDEN

Zur Gegenprobe zwei absichtlich falsche Lösungen aus dem Test. Erstens: config.js ohne Filter, Preset ohne OSV und Pinning, "automerge": true für alles, kein customManager, keine Freigabe, Worker nicht repariert. Zweitens: alles richtig, nur ohne helpers:pinGitHubActionDigests.

Summe: 30 von 100 (Pflichtaufgabe 6: 0 von 15)
✘ NICHT BESTANDEN
Summe: 93 von 100 (Pflichtaufgabe 6: 8 von 15)
✘ NICHT BESTANDEN

93 Punkte reichen nicht: Ungepinnte Actions sind ein offenes Supply-Chain-Risiko, das keine andere Aufgabe aufwiegt.

Musterlösung

Erst nach der Prüfung lesen. Alle Dateien liegen unter ~/renovate-lab/code/anhang-b/loesung/.

  • A1: default.json per git push ins Preset-Repo, dann Bot-Recht per PUT …/collaborators/renovate-bot mit {"permission":"read"} (Tag 11, Drill 1).
  • A2: config.js wie in Tag 9, Drill 5, mit autodiscoverFilter: ['billing/*'] und onboardingConfig.extends: ['local>billing/renovate-config'].
  • A3: POST $A/billing-api/pulls/1/merge mit {"Do":"merge"}.
  • A4–A8: billing-api.json als renovate.json auf main. Security liegt im Preset, damit jedes billing-Repo sie erbt:
{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "description": "Org-Standard für alle Repos der Organisation billing",
  "extends": ["config:recommended", "helpers:pinGitHubActionDigests"],
  "timezone": "Europe/Berlin",
  "osvVulnerabilityAlerts": true
}
{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "extends": ["local>billing/renovate-config"],
  "prConcurrentLimit": 4,
  "prHourlyLimit": 0,
  "platformAutomerge": false,
  "customManagers": [
    {
      "customType": "regex",
      "description": "kubectl-Version im Dockerfile",
      "managerFilePatterns": ["/(^|/)Dockerfile$/"],
      "matchStrings": ["ARG KUBECTL_VERSION=(?<currentValue>\\S+)"],
      "depNameTemplate": "kubernetes/kubernetes",
      "datasourceTemplate": "github-releases"
    }
  ],
  "packageRules": [
    {
      "description": "Produktions-Dependencies nur montags vor 4 Uhr",
      "matchDepTypes": ["dependencies"],
      "schedule": ["* 0-3 * * 1"]
    },
    {
      "description": "devDependencies in einem PR bündeln",
      "matchDepTypes": ["devDependencies"],
      "groupName": "dev-tools"
    },
    {
      "description": "Patches automatisch mergen",
      "matchUpdateTypes": ["patch"],
      "automerge": true
    },
    {
      "description": "devDependencies ohne Major automatisch mergen",
      "matchDepTypes": ["devDependencies"],
      "matchUpdateTypes": ["minor", "patch"],
      "automerge": true
    },
    {
      "description": "express-Major nur nach Freigabe im Dashboard",
      "matchPackageNames": ["express"],
      "matchUpdateTypes": ["major"],
      "dependencyDashboardApproval": true
    }
  ]
}

platformAutomerge: false ist nicht Pflicht. Ohne Branch-Protection würde Forgejo sonst schon beim ersten beliebigen success mergen (Tag 5, Drill 2).

  • A7: Status wie mit ci aus Tag 5, Drill 1: POST $A/billing-api/statuses/<sha> mit {"state":"success","context":"ci/test"}.
  • A8: Haken wie mit tick aus Tag 14, Drill 3, Marker approve-branch=renovate/express-5.x.
  • A9: Der Validator meldet nur den ersten Fehler, der Preset-Tippfehler kommt erst im nächsten Lauf als Issue. Also reparieren, laufen lassen, Issue erneut lesen. So sieht diagnose.txt aus (Zeile 2 gekürzt):
Lauf 1: Error type: The Renovate configuration file contains some invalid settings
Message: Configuration option `prConcurrentLimit` should be an integer. Found: "4" (st
Lauf 2: Error type: Cannot find preset's package (config:recomended)
{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "extends": ["local>billing/renovate-config"],
  "postUpdateOptions": ["gomodTidy"],
  "prConcurrentLimit": 4
}

Die ganze Lösung zum Nachspielen, rund eine Minute plus OSV-Download beim ersten Mal:

~/renovate-lab/code/anhang-b/start.sh
~/renovate-lab/code/anhang-b/loesung/loesung.sh
~/renovate-lab/code/anhang-b/bewertung.sh | tail -2

Erwartet:

Summe: 100 von 100 (Pflichtaufgabe 6: 15 von 15)
✔ BESTANDEN

Teil 2: Wissensfragen

Beantworte jede Frage in ein bis zwei Sätzen, ohne Unterlagen. Mindestens 7 von 10 sollten sitzen.

  1. Warum enthält der Onboarding-PR eines self-hosted Renovate ohne onboardingConfig nur $schema, und was folgt daraus für prHourlyLimit?
  2. Der Preset-Repo-Push ist vergessen, config.js verweist aber schon auf local>billing/renovate-config. Was passiert beim Onboarding von billing-api?
  3. Warum taucht billing/renovate-config in --write-discovered-repos nicht auf, obwohl der Bot es lesen kann, und was ist die eigentliche Zugriffskontrolle?
  4. Warum bot Renovate für express zunächst weder 4.22 noch 5 an, sondern nur 4.20.0?
  5. Was regelt schedule genau, und welche PRs entstehen trotzdem außerhalb des Fensters?
  6. automerge: true ist gesetzt, der Status ist success, der PR bleibt offen. Nenne zwei mögliche Gründe.
  7. Wozu der Kommentar # v3 hinter einem gepinnten Action-Digest?
  8. Warum findet renovate-config-validator den Tippfehler config:recomended nicht?
  9. Ein CronJob mit Renovate ist grün, aber in einem Repo hängt seit Tagen ein Issue „Action Required”. Was fehlt in der globalen Config?
  10. Was unterscheidet dependencyDashboardApproval von einem geschlossenen PR als Mittel gegen ein unerwünschtes Major-Update?

Lösungsschlüssel

  1. Self-hosted gibt es keinen Mend-Standard. Ohne config:recommended gelten die Defaults, also auch prHourlyLimit 2 (Tag 1).
  2. Renovate kann das Preset nicht laden und öffnet „Action Required” mit Cannot find preset's package (local>billing/renovate-config) statt eines PRs.
  3. autodiscover verwirft Repos ohne Push-Recht. Was der Bot nicht schreiben darf, findet er nicht; Filter sind nur die zweite Linie (Tag 9).
  4. Mit osvVulnerabilityAlerts bietet Renovate für eine verwundbare Abhängigkeit nur den Fix an. Normale Updates und Majors folgen erst, wenn der Fix auf main ist.
  5. Wann neue Branches entstehen. Bestehende PRs werden weiter aktualisiert, Security-PRs und per Dashboard freigegebene Branches ignorieren das Fenster.
  6. Renovate mergt nur während eines Laufs (platformAutomerge: false), oder der Status hängt an einem alten Commit, weil Renovate den Branch inzwischen rebased hat.
  7. Der Kommentar hält den Tag lesbar und ist Renovates Anker, um später Digest und Tag gemeinsam zu aktualisieren (Tag 12).
  8. Der Validator prüft Syntax und Optionen, lädt aber keine Presets nach. Den Fehler zeigt erst ein Lauf (Issue) oder --print-config (Tag 11).
  9. exitCodeForErrors: true. Ohne gibt Renovate bei Repo-Fehlern Exit 0 zurück, und kein Alarm schlägt an (Tag 9, Tag 14).
  10. Die Freigabe ist dokumentierte Config mit nachvollziehbarem Haken im Issue. Ein geschlossener PR ist eine unsichtbare Entscheidung, die am PR-Titel hängt.

Teil 3: Selbsteinschätzung

Thema kann ich im Lab gemacht
Onboarding, Config, Manager, customManagers (Tag 1–3, 7) [ ] [ ]
Gruppen, Schedule, Limits, Automerge (Tag 4, 5) [ ] [ ]
Versionen, Digests, Registries (Tag 6, 8) [ ] [ ]
Self-hosted Betrieb, Dienst, Org-Presets (Tag 9–11) [ ] [ ]
Sicherheit und Supply Chain (Tag 12) [ ] [ ]
Monorepos, Dashboard, Fehlersuche (Tag 13–15) [ ] [ ]

Jede Zeile ohne zwei Kreuze: das Kapitel noch einmal durcharbeiten.