4 Commits
Author SHA1 Message Date
claude 0f7062b0c4 fix(release-plugin): Regex — .* greedy mit DOTALL schluckt bis EOF
Mit re.DOTALL matcht .* auch Newlines. Kombination mit (?:\s+.*)?$\n
führte dazu, dass die erste Version-Zeile bis zum Dateiende gefressen
wurde und Capture-Group leer blieb (0 Zeichen).

Fix: .* durch [^\n]* ersetzen, damit erste Zeile genau auf eine Zeile
begrenzt ist. Gilt für beide Changelog-Parser (Block-Extraktion und
entry_pat in readme.txt-Generator).
2026-04-24 14:18:45 +00:00
claude 6c8f3f2d21 docs(runner-setup): Node.js als Pflicht-Voraussetzung für actions/checkout 2026-04-24 14:13:29 +00:00
claude 1eb87ecac6 docs(runner-setup): Sichtbarkeit idf-ci, Security-Einschätzung 2026-04-24 13:35:53 +00:00
claude 64d20da165 docs(runner-setup): Labels gehören in config.yaml, nicht ins register-CLI 2026-04-24 13:02:38 +00:00
2 changed files with 87 additions and 16 deletions
+7 -5
View File
@@ -168,10 +168,11 @@ jobs:
version = os.environ["VERSION"] version = os.environ["VERSION"]
with open("CHANGELOG.md", encoding="utf-8") as f: with open("CHANGELOG.md", encoding="utf-8") as f:
content = f.read() content = f.read()
# "## v<version>" optional gefolgt von " — Datum" und beliebigem Suffix, # "## v<version>" gefolgt von beliebigem Rest der Zeile (auch "— Datum"),
# Inhalt bis zum nächsten "## v<x.y.z>" oder einer "---"-Trennzeile oder EOF. # Inhalt ab nächster Zeile bis zum nächsten "## v<x.y.z>" oder "---" oder EOF.
# [^\n]* statt .*, damit die erste Zeile nicht mit DOTALL bis EOF gefressen wird.
pat = re.compile( pat = re.compile(
r"^##\s+v" + re.escape(version) + r"(?:\s+.*)?$\n(.*?)(?=^##\s+v\d|^---\s*$|\Z)", r"^##\s+v" + re.escape(version) + r"[^\n]*\n(.*?)(?=^##\s+v\d|^---\s*$|\Z)",
re.MULTILINE | re.DOTALL, re.MULTILINE | re.DOTALL,
) )
m = pat.search(content) m = pat.search(content)
@@ -229,9 +230,10 @@ jobs:
readme_path = pathlib.Path(sys.argv[1]) readme_path = pathlib.Path(sys.argv[1])
changelog_path = pathlib.Path(sys.argv[2]) changelog_path = pathlib.Path(sys.argv[2])
# CHANGELOG.md parsen: Einträge "## v<x.y.z> — <Datum?>" bis zum nächsten "## v…" oder "---" oder EOF # CHANGELOG.md parsen: Einträge "## v<x.y.z> — <Datum?>" bis zum nächsten "## v…" oder "---" oder EOF.
# [^\n]* für die erste Zeile, damit DOTALL nicht greedy über Zeilen frisst.
entry_pat = re.compile( entry_pat = re.compile(
r"^##\s+v(\d+\.\d+\.\d+)(?:\s+—\s+(\S+))?(?:\s+.*)?$\n(.*?)(?=^##\s+v\d|^---\s*$|\Z)", r"^##\s+v(\d+\.\d+\.\d+)(?:\s+—\s+(\S+))?[^\n]*\n(.*?)(?=^##\s+v\d|^---\s*$|\Z)",
re.MULTILINE | re.DOTALL, re.MULTILINE | re.DOTALL,
) )
content = changelog_path.read_text(encoding="utf-8") content = changelog_path.read_text(encoding="utf-8")
+80 -11
View File
@@ -10,10 +10,55 @@ Der Runner ist ein einzelnes ausführbares Binary (`act_runner`), das sich beim
Der Runner **baut** die Plugin-ZIPs und legt sie als Gitea-Release-Assets ab. Er **verteilt** nichts an Kunden — das ist Aufgabe des Master-Key-Plugins. Der Runner **baut** die Plugin-ZIPs und legt sie als Gitea-Release-Assets ab. Er **verteilt** nichts an Kunden — das ist Aufgabe des Master-Key-Plugins.
## Voraussetzungen in Gitea
Damit der Runner Reusable-Workflows aus `idf-ci` lesen kann, muss das Repo für ihn erreichbar sein. Der beim Job generierte Token ist nur für das aufrufende Plugin-Repo gültig und kann kein anderes privates Repo klonen.
**Daher: `ideenfabrik/idf-ci` muss auf Sichtbarkeit „Public" (oder „Limited", falls in der Gitea-Version verfügbar) stehen.**
- **Public** — lesbar für alle, die die Gitea-Instanz erreichen.
- **Limited** — lesbar für alle eingeloggten Gitea-User. In neueren Gitea-Versionen verfügbar. Für unseren Fall äquivalent zu Public, weil der Runner eh mit Token angemeldet ist.
- **Private** — funktioniert nicht, weil der Job-Token keinen Repo-übergreifenden Lesezugriff hat.
**Zusätzlich:** Gitea-weite Einstellung `REQUIRE_SIGNIN_VIEW` muss auf `false` stehen. Sonst überschreibt sie die per-Repo-Sichtbarkeit und erzwingt Login auch für Public-Repos. Bei Docker-Setups wird die `app.ini` oft aus Environment-Variablen regeneriert — Änderungen direkt in der Datei gehen beim Container-Neustart verloren. Korrekter Weg: Environment-Variable setzen:
```
GITEA__service__REQUIRE_SIGNIN_VIEW=false
```
Je nach Setup in der `docker-compose.yml`, im systemd-Unit oder in der Plesk-Gitea-Extension. Container neu starten.
### Ist das ein Sicherheitsproblem?
Das Risiko ist niedrig, weil das Repo ausschließlich CI-Baustoff enthält:
- Keine Access-Tokens, API-Keys oder Passwörter (Secrets werden zur Laufzeit injiziert, nie committet)
- Keine Plugin-Quellcodes, keine Business-Logik, keine Kundendaten
- Kein Zugriff auf Produktions-Systeme
Öffentlich lesbar sind nur: der Release-Workflow (Bau-Logik), die Doku und das Caller-Template. Standard-CI-Praxis, wie bei vielen Open-Source-Projekten.
Falls der Gitea-Server aus dem Internet erreichbar ist, bedeutet „Public" tatsächlich weltweit lesbar. Ist der Gitea-Server nur intern/VPN-gebunden erreichbar, ist „Public" effektiv identisch mit „intern lesbar". Im Zweifel: Sichtbarkeit auf „Limited" setzen, dann muss man wenigstens angemeldet sein, um zu lesen.
### Umstellung der Repo-Sichtbarkeit
1. Repo öffnen: https://git.ihre-ideenfabrik.de/ideenfabrik/idf-ci
2. Settings → ganz runterscrollen → „Danger Zone"
3. **Change Visibility** → Public (oder Limited, falls verfügbar)
4. Bestätigen
Einmalige Aktion pro Instanz.
## Voraussetzungen auf dem Server ## Voraussetzungen auf dem Server
- Linux (Debian/Ubuntu; der IDF-Plesk-Host reicht) - Linux (Debian/Ubuntu; der IDF-Plesk-Host reicht)
- Outbound-HTTPS zu `git.ihre-ideenfabrik.de` - Outbound-HTTPS zu `git.ihre-ideenfabrik.de` und zu `github.com` (für standard Gitea-/GitHub-Actions wie `actions/checkout`)
- **Node.js 20 (LTS) oder neuer** — zahlreiche Actions (`actions/checkout`, viele weitere) sind JavaScript-basiert und benötigen Node zur Ausführung. Installation (Debian/Ubuntu):
```bash
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo bash -
sudo apt install -y nodejs
```
Prüfen: `node --version` (mindestens `v20.x`).
- Standard-Tools verfügbar: `bash`, `python3`, `zip`, `unzip`, `rsync`, `curl`, `jq`, `git` - Standard-Tools verfügbar: `bash`, `python3`, `zip`, `unzip`, `rsync`, `curl`, `jq`, `git`
Falls einzelne Tools fehlen: `sudo apt install -y python3 zip unzip rsync curl jq git` Falls einzelne Tools fehlen: `sudo apt install -y python3 zip unzip rsync curl jq git`
- systemd (Standard bei Debian/Ubuntu) - systemd (Standard bei Debian/Ubuntu)
@@ -35,16 +80,30 @@ sudo chmod +x act_runner
Architektur-Variante: bei ARM-Servern `linux-arm64` statt `linux-amd64` wählen. Architektur-Variante: bei ARM-Servern `linux-arm64` statt `linux-amd64` wählen.
### 2. Konfigurationsdatei erzeugen ### 2. Konfigurationsdatei erzeugen und Labels eintragen
```bash ```bash
sudo ./act_runner generate-config | sudo tee config.yaml > /dev/null sudo ./act_runner generate-config | sudo tee config.yaml > /dev/null
``` ```
Die Default-Konfiguration ist ok. Relevante Stellen, falls angepasst werden muss: **Wichtig:** `act_runner` akzeptiert Labels **nur aus der Config**, nicht als CLI-Flag beim Registrieren. Die Default-Labels zeigen auf Docker-Images, die wir nicht brauchen. Ersetze sie durch Host-Modus-Labels:
- `runner.capacity` — wie viele Jobs parallel laufen (Default: 1, für den Anfang ok) ```bash
- `runner.labels` — Labels, die der Runner kann. Hier setzen wir sie beim `register` explizit. sudo nano /opt/act_runner/config.yaml
```
Im Block `runner:` den vorhandenen `labels:`-Block **vollständig ersetzen** durch:
```yaml
labels:
- "self-hosted:host"
- "linux:host"
- "x64:host"
```
Suffix `:host` = Jobs laufen direkt auf dem Host, ohne Docker. Damit sparen wir uns Docker als weitere Abhängigkeit. Speichern und verlassen.
Andere Default-Werte in `config.yaml` können bleiben. Bei Bedarf später anpassen: `runner.capacity` für parallele Jobs (Default 1 ist für den Anfang ok).
### 3. Registrierungstoken in Gitea holen ### 3. Registrierungstoken in Gitea holen
@@ -53,23 +112,22 @@ Organisation-scoped Runner (empfohlen, läuft für alle IDF-Repos):
1. In Gitea einloggen als Admin. 1. In Gitea einloggen als Admin.
2. Navigation: Organization **ideenfabrik** → Settings → **Actions** → **Runners**. 2. Navigation: Organization **ideenfabrik** → Settings → **Actions** → **Runners**.
3. Button **„Create new Runner"**. 3. Button **„Create new Runner"**.
4. Registrierungstoken kopieren. 4. Registrierungstoken kopieren. Token ist einmalig — für eine zweite Registrierung einen neuen generieren.
Alternativ: Instance-weit unter Site Administration → Actions → Runners (dann verfügbar für alle Organisationen). Alternativ: Instance-weit unter Site Administration → Actions → Runners (dann verfügbar für alle Organisationen).
### 4. Runner registrieren ### 4. Runner registrieren
```bash ```bash
sudo ./act_runner register \ sudo /opt/act_runner/act_runner register \
--config /opt/act_runner/config.yaml \ --config /opt/act_runner/config.yaml \
--instance https://git.ihre-ideenfabrik.de \ --instance https://git.ihre-ideenfabrik.de \
--token <TOKEN_AUS_SCHRITT_3> \ --token <TOKEN_AUS_SCHRITT_3> \
--name idf-plesk-runner \ --name idf-plesk-runner \
--labels self-hosted:host,linux:host,x64:host \
--no-interactive --no-interactive
``` ```
Die Labels `self-hosted`, `linux` und `x64` decken die Workflow-`runs-on:`-Kombinationen ab. Suffix `:host` = Jobs laufen direkt auf dem Host, ohne Docker. Damit sparen wir uns Docker als weitere Abhängigkeit. Kein `--labels`-Flag — die Labels kommen aus der Config (siehe Schritt 2). Falls versehentlich mitgegeben, erscheint die Warnung `Labels from command will be ignored, use labels defined in config file.`
Nach erfolgreicher Registrierung liegt eine Datei `.runner` im Arbeitsverzeichnis — die ist der Runner-State, nicht weiterkopieren oder committen. Nach erfolgreicher Registrierung liegt eine Datei `.runner` im Arbeitsverzeichnis — die ist der Runner-State, nicht weiterkopieren oder committen.
@@ -111,6 +169,7 @@ In Gitea prüfen:
1. Organization **ideenfabrik** → Settings → **Actions** → **Runners**. 1. Organization **ideenfabrik** → Settings → **Actions** → **Runners**.
2. Der neue Runner taucht mit Status **Online** auf. 2. Der neue Runner taucht mit Status **Online** auf.
3. In der Labels-Spalte müssen `self-hosted`, `linux`, `x64` stehen. Wenn stattdessen `ubuntu-latest` o. Ä. dort stehen, wurde ohne die Labels aus Schritt 2 registriert → Schritt 2 prüfen und bei Runs-Hängen neu registrieren (siehe Troubleshooting).
### 7. Pilot-Test ### 7. Pilot-Test
@@ -120,7 +179,8 @@ Einen Plugin-Repo mit Caller-Workflow nehmen (z. B. `idf-post-prefix`), Tag `v<X
- **Logs:** `sudo journalctl -u act_runner -f` (tail-folgen) oder `journalctl -u act_runner --since '1 hour ago'`. - **Logs:** `sudo journalctl -u act_runner -f` (tail-folgen) oder `journalctl -u act_runner --since '1 hour ago'`.
- **Runner-Update:** neues `act_runner`-Binary herunterladen, ersetzen, `sudo systemctl restart act_runner`. - **Runner-Update:** neues `act_runner`-Binary herunterladen, ersetzen, `sudo systemctl restart act_runner`.
- **Label-Änderung:** `act_runner register` mit neuen Labels erneut ausführen (alten Runner in Gitea-UI vorher deaktivieren), Service neu starten. - **Label-Änderung:** Labels in `config.yaml` anpassen, Service neu starten (`sudo systemctl restart act_runner`). Der Daemon sendet die aktualisierten Labels beim nächsten Handshake an Gitea.
- **Neu-Registrierung (z. B. nach kaputtem State):** `sudo rm /opt/act_runner/.runner`, neuen Token aus Gitea holen, Schritt 4 erneut ausführen, Service neu starten.
- **Deregistrierung:** Runner in Gitea-UI löschen, `.runner`-Datei auf dem Server entfernen, Service stoppen. - **Deregistrierung:** Runner in Gitea-UI löschen, `.runner`-Datei auf dem Server entfernen, Service stoppen.
## Server-Wechsel — Checkliste ## Server-Wechsel — Checkliste
@@ -136,8 +196,17 @@ Damit ist das komplette Build-System portabel: die Bauanleitung lebt in diesem R
## Troubleshooting ## Troubleshooting
**Warnung `Labels from command will be ignored` beim Registrieren.**
Du hast `--labels …` als CLI-Flag gesetzt, aber `act_runner` nimmt Labels nur aus der Config. Schritt 2 durchgehen, Labels in `config.yaml` eintragen. Dann `sudo rm /opt/act_runner/.runner`, neuen Token holen, Registrierung ohne `--labels`-Flag erneut ausführen.
**Run bricht ab mit `Unable to clone … authentication required`.**
Entweder `idf-ci` steht auf Private, oder Gitea-weit ist `REQUIRE_SIGNIN_VIEW = true` aktiv. Abschnitt „Voraussetzungen in Gitea" durchgehen. Bei Docker-Setup die Environment-Variable `GITEA__service__REQUIRE_SIGNIN_VIEW=false` setzen und Container neu starten. Danach den Run über den Re-run-Button in der Gitea-Actions-UI neu starten.
**Run bricht ab mit `Cannot find: node in PATH`.**
Node.js ist nicht installiert oder nicht im PATH. Abschnitt „Voraussetzungen auf dem Server" durchgehen und Node 20 LTS installieren. Nach `sudo apt install -y nodejs` läuft der nächste Re-run.
**Runs hängen auf `queued`, Runner steht aber auf Online.** **Runs hängen auf `queued`, Runner steht aber auf Online.**
Label-Mismatch. Der Workflow schreibt `runs-on: self-hosted`, der Runner muss dasselbe Label haben. `act_runner register --labels …` erneut, Service neu starten. Label-Mismatch. Der Workflow schreibt `runs-on: self-hosted`, der Runner muss dasselbe Label anbieten. In der Gitea-UI die Labels des Runners prüfen — stehen dort nicht `self-hosted, linux, x64`, liegt es an Schritt 2.
**Runner zeigt `offline` nach systemd-Start.** **Runner zeigt `offline` nach systemd-Start.**
`sudo journalctl -u act_runner --since '5 min ago'` lesen. Häufige Ursachen: Token abgelaufen, DNS funktioniert nicht, `git.ihre-ideenfabrik.de` nicht erreichbar. `sudo journalctl -u act_runner --since '5 min ago'` lesen. Häufige Ursachen: Token abgelaufen, DNS funktioniert nicht, `git.ihre-ideenfabrik.de` nicht erreichbar.