GitLab Smart-Home-Integration, kostenlos und Open Source
GitLab-Projekte verfolgen: Releases, Issues, Merge-Requests, Pipelines, Szenen und Widgets.
Veröffentlicht von William-De71
- Geräte
- Version 0.1.0
- Erfordert Gladys >=5.3.0
- ★ 0
Überblick
Diese Integration verfolgt GitLab-Projekte in Gladys, auf gitlab.com oder auf deinem eigenen, selbst gehosteten GitLab: Ihre Releases, Issues, Merge-Requests, Pipelines und Sterne werden zu Geräten, Szenenauslösern und Dashboard-Widgets. Sie liest die offizielle REST-API v4 von GitLab mit einem Zugriffstoken, nur lesend, und schreibt nie in GitLab.
Jedes verfolgte Projekt wird zu einem Gerät, neben einem Gerät für dein Konto. Szenenauslöser reagieren auf ein neues Release, Issue, einen neuen Merge-Request, Commit oder Stern und auf das Ende der Pipeline des Standard-Branches.
GitLab ist eine Marke von GitLab Inc. Diese Integration ist nicht mit GitLab verbunden.
Voraussetzungen
- Gladys Assistant 5.3.0 oder neuer.
- Ein Konto auf gitlab.com oder auf einem selbst gehosteten GitLab.
- Ein Zugriffstoken mit dem Bereich
read_api: Öffne in GitLab Einstellungen → Zugriffstoken, füge ein Token hinzu, hake nur read_api an und kopiere es. Ein Gruppen- oder Projekt-Zugriffstoken mitread_apigeht auch.
Konfiguration
| Feld | Rolle |
|---|---|
| Adresse der GitLab-Instanz | Standardmäßig https://gitlab.com, oder die Adresse deines selbst gehosteten GitLab. |
| Zugriffstoken | Das Token mit dem Bereich read_api. |
| Zu verfolgende Projekte | Gruppe/Projekt (mit Untergruppen) oder sein Link; Gruppe/* und Gruppe/Präfix*; höchstens 30. |
| Leseintervall (s) | 60 bis 3.600 Sekunden, standardmäßig 120; auch die Verzögerung der Szenenauslöser. |
| Sprache der Texte | Namen der Geräte, Zusammenfassungen und Ausgaben der Szenen; standardmäßig automatisch. |
Speichern, dann Verbindung testen drücken: Das Ergebnis nennt das Konto des Tokens und sagt, wie viele Projekte gelesen wurden.
Verwendung
Geräte
Erstelle in Entdecken das Gerät „GitLab @Benutzername“ (Follower, gefolgt, Projekte) und ein Gerät „GitLab Gruppe/Projekt“ pro Projekt: Sterne, Forks, offene Issues, offene und gemergte Merge-Requests, neuestes Release, Tag, Commit, Issue und Merge-Request sowie die Pipeline des Standard-Branches (Erfolgreich, Fehlgeschlagen, Abgebrochen, Läuft).
Szenenauslöser
Alle filtern nach Projekt (leer lassen für jedes):
- Release veröffentlicht: Ein kommendes Release zählt an seinem Datum.
- Issue geöffnet, Merge-Request geöffnet (Variable
draft). - Neuer Commit auf dem Standard-Branch.
- Neuer Stern.
- Pipeline abgeschlossen: erfolgreich, fehlgeschlagen oder abgebrochen (Filter: Ergebnis).
Jedes Ereignis liefert das Projekt, das Element (Nummer, Titel, Autor, Link) und einen Satz summary. Die erste Abfrage nach einem Start oder einem neuen Token ist die Referenz: Nichts wird ausgelöst.
Szenenaktion
Ein Projekt lesen liefert seine Zähler, neuestes Release und neuesten Commit, Pipeline und einen Satz summary. Ein unbekannter Zähler ist -1.
Widgets
- GitLab-Projekt: Sterne, Forks, Issues, Merge-Requests, neuestes Release, Pipeline, letzter Commit, ein Link.
- GitLab-Aktivität: die neuesten Releases, Issues, Merge-Requests und Commits aller Projekte (oder eines), neueste zuerst.
- GitLab-Konto: Follower, gefolgt, Projekte und das verbleibende API-Kontingent auf gitlab.com.
Fehlerbehebung
- „GitLab hat das Token abgelehnt“: Das Token ist falsch, abgelaufen oder widerrufen: Erstelle ein neues.
- „GitLab hat den Zugriff mit diesem Token verweigert“: Dem Token fehlt der Bereich
read_api. - „Nicht gefunden oder für das Token nicht sichtbar“: Prüfe den Pfad (
Gruppe/Untergruppe/Projekt) und ob das Token das Projekt sieht (private Projekte brauchen das Token eines Mitglieds). - „GitLab ist unter dieser Adresse nicht erreichbar“: Prüfe die Adresse deiner Instanz und ob Gladys sie erreicht.
- Keine Pipeline oder Merge-Requests: Das Projekt hat sie deaktiviert oder noch keine Pipeline auf seinem Standard-Branch; diese Funktionen werden einfach ausgelassen.
- Melde Probleme mit den Versionen von Gladys und der Integration und ihren Logs; füge nie dein Token ein.
Konfigurationseinstellungen
Diese Einstellungen fragt GitLab in seinem Konfigurationsbildschirm in Gladys ab.
| Einstellung | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
| Zugriff auf GitLab | section | Nein | Die Integration liest gitlab.com oder dein eigenes GitLab mit einem Zugriffstoken. Öffne in GitLab die Einstellungen, dann Zugriffstoken, und füge ein persönliches Token nur mit dem Bereich read_api hinzu (nur lesend). Ein Gruppen- oder Projekt-Zugriffstoken mit read_api geht auch. Kopiere das Token hierher. |
| Adresse der GitLab-Instanz | string | Nein | https://gitlab.com oder die Adresse deines selbst gehosteten GitLab (https://gitlab.example.com). |
| Zugriffstoken | secret | Ja | Beginnt mit glpat- (persönlich oder Projekt) oder glgat- (Gruppe), mit dem Bereich read_api. |
| Projekte | section | Nein | Jedes verfolgte Projekt wird zu einem Gerät im Reiter Entdecken, neben einem Gerät für dein Konto. Szenenauslöser und Widgets wählen sie über das Gerät aus. |
| Zu verfolgende Projekte | string | Nein | Gruppe/Projekt (mit Untergruppen: Gruppe/Untergruppe/Projekt) oder sein Link, durch Kommas getrennt (höchstens 30). Gruppe/* verfolgt alle Projekte einer Gruppe oder eines Benutzers, Gruppe/gladys-* die mit gladys- beginnenden. |
| Abfrageintervall (s) | number | Nein | Wie oft GitLab gelesen wird, zwischen 60 und 3600 Sekunden. Das ist auch die Reaktionszeit der Szenenauslöser. |
| Sprache der Texte | select | Nein | Gerätenamen, Zusammenfassungen und Ausgaben der Szenen. Automatisch: die Sprache deines Dashboards, sobald ein GitLab-Widget angezeigt wurde. |
So installierst du GitLab in Gladys
- Öffne in Gladys Integrationen: GitLab erscheint im Katalog neben den nativen Integrationen, mit einem Community-Badge.
- Klicke auf Installieren. Gladys lädt das Docker-Image (
ghcr.io/william-de71/gladys-gitlab:0.1.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/William-De71/gladys-gitlab.
GitLab benötigt Gladys >=5.3.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
GitLab 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 William-De71 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