Woodpecker CI Smart-Home-Integration, kostenlos und Open Source

Deine Woodpecker-CI-Pipelines in Gladys: Status, Fehlerwarnungen, Neustart aus einer Szene.
Woodpecker CI ist eine freie, selbst gehostete Engine für Continuous Integration, oft zusammen mit Forgejo, Gitea oder GitHub. Diese Integration verfolgt ihre Pipelines: Jedes Repository wird ein Gerät mit dem Status seiner letzten Pipeline, ihrer Nummer, ihrem Branch, ihrem Ereignis und ihrer Dauer, und zeigt, ob gerade eine Pipeline läuft; ein Gerät Woodpecker CI sagt, ob der Server antwortet, und fasst Warteschlange, freie Agenten und fehlgeschlagene Repositorys zusammen. Szenen können auf eine beendete Pipeline oder ein Repository reagieren, das fehlschlägt oder wieder grün wird, ein Repository lesen und, wenn du es erlaubst, die letzte Pipeline neu starten. Ein Dashboard-Widget zeigt die letzten Pipelines auf einen Blick.
Getestet mit einem echten Woodpecker-3.20-Server, einer Forgejo-Forge und einem Agenten (Docker); noch nicht mit einer echten Gladys-Instanz: Rückmeldungen sind willkommen in den Issues.
Was du brauchst
- Gladys Assistant 5.1.0 oder neuer.
- Einen Woodpecker-Server, Version 3 oder neuer, vom Gladys-Rechner aus erreichbar.
- Ein persönliches Zugriffstoken eines Woodpecker-Benutzers. Verfolgt werden die aktiven Repositorys, die dieser Benutzer sieht. Warteschlange und Agenten gibt es nur mit dem Token eines Admins; zum Neustarten einer Pipeline braucht es das Recht push auf dem Repository.
Bei jeder Aktualisierung (standardmäßig jede Minute) stellt die Integration zwei leichte Anfragen (die Repositorys mit ihrer letzten Pipeline, die Warteschlange), plus eine pro Repository, dessen Pipelines sich seit dem letzten Lesen geändert haben (seine zehn neuesten Pipelines). Ein Neustart kostet eine Anfrage, nur wenn eine Szene ihn verlangt.
Erste Schritte
1. Ein persönliches Zugriffstoken erstellen
Klicke in Woodpecker oben rechts auf deinen Avatar, dann auf Persönliches Zugriffstoken, und kopiere das angezeigte Token. Halte es geheim: Es gibt die Rechte deines Benutzers. Ein eigener Benutzer, nur Mitglied der zu verfolgenden Repositorys, begrenzt, was Gladys sehen kann; Warteschlange und Agenten bleiben dann unbekannt.
2. Die Integration konfigurieren
Öffne in Gladys Integrationen → Woodpecker CI → Konfiguration und fülle aus:
- Adresse von Woodpecker: die Adresse, mit der du Woodpecker öffnest,
http://192.168.1.2:8000oderhttps://ci.example.com(behalte den Unterpfad, falls Woodpecker unter einem läuft). - Persönliches Zugriffstoken: das Token aus Schritt 1.
- Zu verfolgende Repositorys: leer für alle aktiven Repositorys (höchstens
50), sonst
Besitzer/Nameoder aus der Forge kopierte Links, durch Kommas getrennt. Ein Besitzer allein verfolgt alle seine Repositorys. Beispiel:alice/website, meine-org. - Berücksichtigte Pipelines: Nur Standard-Branch (Standard) nimmt die Pushes, geplanten und manuellen Pipelines und Deployments des Standard-Branches: Ein fehlgeschlagener Pull-Request färbt das Repository nicht rot. Alle nimmt jede Pipeline: Branches, Pull-Requests und Tags.
- Szenen dürfen Pipelines neu starten: standardmäßig aus. Schalte es ein, um die Aktion Letzte Woodpecker-Pipeline neu starten zu nutzen.
- Aktualisierungsintervall und Sprache der Namen.
Klicke auf Verbindung testen: Woodpecker und seine Version, wie viele Repositorys verfolgt werden und fehlschlagen, Warteschlange und freie Agenten (oder dass dafür ein Admin-Token nötig ist), ob Szenen Pipelines neu starten dürfen, und die aufgelisteten Repositorys, die Woodpecker nicht kennt.
3. Die Geräte hinzufügen
Füge unter Entdecken das Gerät Woodpecker CI und die gewünschten Repositorys hinzu. Deren Werte kommen sofort. Szenenauslöser und Widget funktionieren auch für ein nicht als Gerät hinzugefügtes Repository.
Die Geräte
Ein Gerät pro Repository
Benannt nach dem vollen Namen des Repositorys (Besitzer/Name), erkannt an
seiner Woodpecker-ID: Ein in der Forge umbenanntes Repository behält sein Gerät.
| Funktion | Typ | Wert |
|---|---|---|
| Status | Text | Erfolgreich, Fehlgeschlagen, Fehler, Abgebrochen, Abgelehnt, Übersprungen, Wartend, Läuft, Wartet auf Freigabe oder Keine Pipeline |
| Letzte Pipeline erfolgreich | binär | 1, wenn die letzte beendete Pipeline erfolgreich war, 0, wenn sie fehlschlug oder nicht laufen konnte (Fehler) |
| Pipeline läuft | binär | 1, solange eine Pipeline läuft oder auf einen Agenten wartet |
| Nummer der letzten Pipeline | Zähler | Nummer der letzten Pipeline |
| Dauer der letzten Pipeline | Dauer | Dauer der letzten beendeten Pipeline, in Sekunden |
| Branch | Text | Branch der letzten Pipeline |
| Ereignis | Text | was sie gestartet hat: Push, Pull-Request, Tag, Release, Deployment, Geplant, Manuell |
Solange eine Pipeline läuft, zeigt der Status Läuft; Letzte Pipeline erfolgreich und Dauer der letzten Pipeline behalten die Werte der vorherigen. Eine abgebrochene oder übersprungene Pipeline lässt Letzte Pipeline erfolgreich unverändert.
Das Gerät Woodpecker CI
| Funktion | Typ | Wert |
|---|---|---|
| Erreichbar | binär | 1, wenn der Server antwortet, sonst 0 |
| Wartende Workflows | Zähler | Workflows, die auf einen Agenten warten (Admin-Token) |
| Laufende Workflows | Zähler | laufende Workflows (Admin-Token) |
| Freie Agenten | Zähler | verbundene, freie Agenten: Ein beschäftigter Agent zählt nicht (Admin) |
| Fehlgeschlagene Repositorys | Zähler | verfolgte Repositorys, deren letzte entscheidende Pipeline fehlschlug |
Mit einem Token, das nicht einem Admin gehört, werden die drei Zahlen der Warteschlange nicht veröffentlicht.
Dashboard
Das Widget Woodpecker-Pipelines zeigt eine Zeile pro Repository mit Status, Nummer und Branch seiner letzten Pipeline: zuerst die fehlschlagenden Repositorys (weiter rot, während eine neue Pipeline läuft), dann die laufenden. Eine Zeile darüber nennt wartende und laufende Workflows und freie Agenten (Admin-Token). Wähle in den Einstellungen Repositorys aus oder lass das Feld für alle leer; die Warteschlangen-Zeile und die Schaltfläche Aktualisieren lassen sich ausblenden. Aktualisieren liest Woodpecker sofort neu. Die Zeilen tragen die in Gladys vergebenen Namen.
Szenen
Auslöser
- Woodpecker-Pipeline beendet: Eine Pipeline eines verfolgten Repositorys ist beendet, egal mit welchem Ergebnis (Filter auf Repository und Ergebnis: erfolgreich, fehlgeschlagen, Fehler, abgebrochen). Variablen: Name des Repositorys, Nummer der Pipeline, Ergebnis in Worten, Branch, Ereignis, Dauer in Sekunden, Link und eine Zusammenfassung für eine Nachricht.
- Woodpecker-Repository fehlgeschlagen oder wieder grün: Ein Repository schlägt fehl (eine fehlgeschlagene Pipeline oder ein Fehler nach einem Erfolg, oder seine erste Pipeline schlägt fehl) oder ist nach einem Fehler wieder erfolgreich (Filter auf Repository und Änderung). Variablen: Name des Repositorys, Nummer der Pipeline, Ergebnis, Branch, Link und eine Zusammenfassung.
Nur die berücksichtigten Pipelines (siehe Berücksichtigte Pipelines) lösen diese Szenen aus. Das erste Lesen eines Repositorys lernt nur seinen Zustand: Die Vergangenheit wird nie gemeldet. Höchstens drei Pipelines pro Repository und Lesen werden gemeldet. Was gesehen wurde, behält die Integration: Ein Neustart verpasst kein Ereignis und meldet keines doppelt.
Aktionen
- Letzte Woodpecker-Pipeline neu starten: startet die neueste berücksichtigte Pipeline eines verfolgten Repositorys auf demselben Commit neu; Woodpecker legt eine neue Pipeline an. Erfordert Szenen dürfen Pipelines neu starten in der Konfiguration. Variablen: Name des Repositorys, Nummer der neu gestarteten Pipeline, Nummer der neuen und ihr Link. Nutze Woodpecker-Pipeline beendet, um auf ihr Ende zu reagieren.
- Woodpecker-Repository lesen: der Zustand eines verfolgten Repositorys als Variablen für die nächsten Aktionen: Status in Worten, letztes Ergebnis, letzte Pipeline erfolgreich, Pipeline läuft, Nummer und Dauer der letzten Pipeline, Branch, Ereignis, Link.
Szenenideen
- Woodpecker-Repository fehlgeschlagen oder wieder grün, Änderung „Fehlgeschlagen“ → die Bürolampe rot schalten und die Zusammenfassung senden; Änderung „Wieder grün“ → wieder weiß.
- Woodpecker-Pipeline beendet für dein Deployment-Repository mit Ergebnis „Erfolgreich“ → dir „die neue Version ist online“ schicken.
- Jeden Morgen um 7:00 → Letzte Woodpecker-Pipeline neu starten eines Repositorys, dessen Tests von externen Daten abhängen, falls es nachts fehlschlug.
Fehlerbehebung
- Woodpecker antwortet nicht: Prüfe die Adresse vom Gladys-Rechner aus
(gleicher Port, gleiches Protokoll); ein Gladys in Docker erreicht den Host
über seine IP-Adresse, nicht über
localhost. - Die Adresse leitet um: Gib die
https://-Adresse ein, bei der der Browser landet, mit Unterpfad, falls vorhanden. - Token abgelehnt: Das Token wurde neu erzeugt (Woodpecker behält nur eines pro Benutzer) oder falsch kopiert: Kopiere es erneut.
- Keine Woodpecker-API unter dieser Adresse: Die Adresse zeigt auf die Forge oder einen anderen Dienst, oder der Unterpfad fehlt.
- Woodpecker hat abgelehnt: Das Token braucht das Recht push auf diesem Repository: Nutze das Token eines Benutzers, der pushen darf, oder lass das Neustarten aus.
- Ein Repository erscheint nicht: Es ist in Woodpecker nicht aktiv, sein Benutzer sieht es nicht, oder mehr als 50 Repositorys passen zur Liste.
- Zertifikat abgelehnt: Ein selbst signiertes Zertifikat wird nicht
akzeptiert; nutze im lokalen Netz die
http://-Adresse.
Grenzen
- Das Neustarten der letzten Pipeline ist der einzige Befehl und standardmäßig aus. Pipelines lassen sich aus Gladys weder abbrechen noch freigeben.
- Höchstens 50 Repositorys; Woodpecker wird höchstens jede Minute gelesen: Ein Ereignis kommt bis zu ein Intervall später.
- Die zehn neuesten Pipelines eines Repositorys werden gelesen: Enden mehr als zehn zwischen zwei Lesevorgängen, werden die ältesten nicht gemeldet.
- Schritte, Logs und Workflows einer Pipeline werden nicht gelesen, die Agenten auch nicht einzeln.
- Woodpecker 3 oder neuer: Ältere Versionen liefern die letzte Pipeline jedes Repositorys nicht.
- Die Texte der Geräte und Szenen folgen der Sprache der Konfiguration; die Funktionsnamen werden beim Hinzufügen eines Geräts festgelegt.
Konfigurationseinstellungen
Diese Einstellungen fragt Woodpecker CI in seinem Konfigurationsbildschirm in Gladys ab.
| Einstellung | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
| Dein Woodpecker-Server | section | Nein | Gib die Adresse deines Woodpecker-Servers und ein persönliches Zugriffstoken ein (klicke oben rechts auf deinen Avatar → Persönliches Zugriffstoken). Die Pipelines der Repositorys, die dieser Benutzer sieht, werden verfolgt. |
| Adresse von Woodpecker | string | Nein | Die Adresse, mit der du Woodpecker öffnest: http://192.168.1.2:8000 oder https://ci.example.com. |
| Persönliches Zugriffstoken | secret | Nein | Liest die Repositorys seines Benutzers. Das Token eines Admins liefert auch die Warteschlange und die verbundenen Agenten. |
| Zu verfolgende Repositorys | string | Nein | Leer: alle aktiven Repositorys (höchstens 50). Sonst Besitzer/Name oder Links, durch Kommas getrennt; ein Besitzer allein verfolgt alle seine Repositorys. |
| Optionen | section | Nein | |
| Berücksichtigte Pipelines | select | Nein | Welche Pipelines den Status eines Repositorys bestimmen und die Szenen auslösen. |
| Szenen dürfen Pipelines neu starten | boolean | Nein | Standardmäßig aus. Wenn an, kann die Aktion „Letzte Woodpecker-Pipeline neu starten“ die Pipeline jedes verfolgten Repositorys neu starten: Der Benutzer des Tokens braucht das Recht push. |
| Aktualisierungsintervall | select | Nein | Wie oft Woodpecker gelesen wird: zwei leichte Anfragen, plus eine pro Repository mit neuen Pipelines. |
| Sprache der Namen | select | Nein | Sprache der Funktionsnamen (beim Hinzufügen eines Geräts festgelegt), der Status und der Szenentexte. |
So installierst du Woodpecker CI in Gladys
- Öffne in Gladys Integrationen: Woodpecker CI erscheint im Katalog neben den nativen Integrationen, mit einem Community-Badge.
- Klicke auf Installieren. Gladys lädt das Docker-Image (
ghcr.io/guim31/gladys-woodpecker:1.0.0) herunter, startet es in einer vom Kern isolierten Sandbox und erzeugt die Oberfläche der Integration (Geräte, Erkennung und Konfiguration). - Öffne den Bildschirm Konfiguration der Integration, fülle die Einstellungen aus und speichere.
- Du kannst sie auch direkt über die URL ihres Repositorys installieren: https://github.com/guim31/gladys-woodpecker.
Woodpecker CI benötigt Gladys >=5.1.0. Der Katalog in Gladys wird stündlich aktualisiert, eine neue Version ist also spätestens eine Stunde nach ihrer Veröffentlichung verfügbar.
Du nutzt Gladys noch nicht? Es ist kostenlos und Open Source: folge der Installationsanleitung, um loszulegen.
Über externe Integrationen
Woodpecker CI ist eine externe Integration: eine Community-Integration, die als Docker-Container verpackt und auf GitHub veröffentlicht wird. Gladys installiert sie mit einem Klick und führt sie in einer vom Kern isolierten Sandbox aus. Sie wird von guim31 veröffentlicht und gepflegt, nicht vom Gladys-Kernteam.
- Alle Integrationen durchsuchen, native und aus der Community
- Deine eigene externe Integration bauen und veröffentlichen
- Quellcode auf GitHub — Quelle dieser Dokumentation