Intégration domotique GitLab, gratuite et open source
Suivez des projets GitLab : versions, issues, merge requests, pipelines, scènes et widgets.
Publiée par William-De71
- Appareils
- Version 0.1.0
- Nécessite Gladys >=5.3.0
- ★ 0
Présentation
Cette intégration suit des projets GitLab dans Gladys, sur gitlab.com ou sur votre propre GitLab auto-hébergé : leurs versions, issues, merge requests, pipelines et étoiles deviennent des appareils, des déclencheurs de scène et des widgets. Elle lit l’API REST v4 officielle de GitLab avec un jeton d’accès en lecture seule, et n’écrit jamais dans GitLab.
Chaque projet suivi devient un appareil, à côté d’un appareil pour votre compte. Des déclencheurs de scène réagissent à une nouvelle version, issue, merge request, à un nouveau commit ou à une nouvelle étoile, et à la fin du pipeline de la branche par défaut.
GitLab est une marque de GitLab Inc. Cette intégration n’est pas affiliée à GitLab.
Prérequis
- Gladys Assistant 5.3.0 ou plus récent.
- Un compte sur gitlab.com ou sur un GitLab auto-hébergé.
- Un jeton d’accès avec la portée
read_api: dans GitLab, ouvrez Préférences → Jetons d’accès, ajoutez un jeton, cochez seulement read_api et copiez-le. Un jeton d’accès de groupe ou de projet avecread_apiconvient aussi.
Configuration
| Champ | Rôle |
|---|---|
| Adresse de l’instance GitLab | https://gitlab.com par défaut, ou l’adresse de votre GitLab auto-hébergé. |
| Jeton d’accès | Le jeton avec la portée read_api. |
| Projets à suivre | groupe/projet (sous-groupes compris) ou son lien ; groupe/* et groupe/préfixe* ; 30 au plus. |
| Intervalle de lecture (s) | 60 à 3 600 secondes, 120 par défaut ; c’est aussi le délai des déclencheurs. |
| Langue des textes | Noms des appareils, résumés et sorties des scènes ; automatique par défaut. |
Enregistrez, puis appuyez sur Tester la connexion : le résultat nomme le compte du jeton et dit combien de projets ont été lus.
Utilisation
Appareils
Dans Découverte, créez l’appareil « GitLab @utilisateur » (abonnés, abonnements, projets) et un appareil « GitLab groupe/projet » par projet : étoiles, forks, issues ouvertes, merge requests ouvertes et fusionnées, dernière version, tag, commit, issue et merge request, et le pipeline de la branche par défaut (Réussi, Échoué, Annulé, En cours).
Déclencheurs de scène
Tous filtrent par projet (laissez vide pour tous) :
- Version publiée : une version à venir compte à sa date.
- Issue ouverte, Merge request ouverte (variable
draft). - Nouveau commit sur la branche par défaut.
- Nouvelle étoile.
- Pipeline terminé : réussi, échoué ou annulé (filtre : résultat).
Chaque événement donne le projet, l’élément (numéro, titre, auteur, lien) et une phrase summary. La première lecture après un démarrage ou un nouveau jeton sert de référence : rien ne se déclenche.
Action de scène
Lire un projet donne ses compteurs, sa dernière version et son dernier commit, son pipeline et une phrase summary. Un compteur inconnu vaut -1.
Widgets
- Projet GitLab : étoiles, forks, issues, merge requests, dernière version, pipeline, dernier commit, un lien.
- Activité GitLab : les dernières versions, issues, merge requests et commits de tous les projets (ou d’un seul), du plus récent au plus ancien.
- Compte GitLab : abonnés, abonnements, projets, et le quota d’API restant sur gitlab.com.
Dépannage
- « GitLab a refusé le jeton » : le jeton est erroné, expiré ou révoqué : créez-en un nouveau.
- « GitLab a refusé l’accès avec ce jeton » : il manque au jeton la portée
read_api. - « Introuvables ou invisibles pour le jeton » : vérifiez le chemin (
groupe/sous-groupe/projet), et que le jeton voit le projet (un projet privé demande le jeton d’un membre). - « GitLab est injoignable à cette adresse » : vérifiez l’adresse de votre instance, et que Gladys peut la joindre.
- Pas de pipeline ni de merge requests : le projet les a désactivés, ou n’a pas encore de pipeline sur sa branche par défaut ; ces fonctionnalités sont simplement laissées de côté.
- Signalez un problème avec les versions de Gladys et de l’intégration et ses journaux ; ne collez jamais votre jeton.
Paramètres de configuration
Voici les paramètres demandés par GitLab dans son écran de configuration dans Gladys.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| Accès à GitLab | section | Non | L’intégration lit gitlab.com ou votre propre GitLab avec un jeton d’accès. Dans GitLab, ouvrez Préférences, puis Jetons d’accès, et ajoutez un jeton personnel avec la seule portée read_api (lecture seule). Un jeton d’accès de groupe ou de projet avec read_api convient aussi. Copiez le jeton ci-dessous. |
| Adresse de l’instance GitLab | string | Non | https://gitlab.com, ou l’adresse de votre GitLab auto-hébergé (https://gitlab.example.com). |
| Jeton d’accès | secret | Oui | Commence par glpat- (personnel ou de projet) ou glgat- (groupe), avec la portée read_api. |
| Projets | section | Non | Chaque projet suivi devient un appareil dans l’écran de découverte, à côté d’un appareil pour votre compte. Les déclencheurs de scène et les widgets les choisissent par appareil. |
| Projets à suivre | string | Non | groupe/projet (sous-groupes compris : groupe/sous-groupe/projet) ou son lien, séparés par des virgules (30 au plus). groupe/* suit tous les projets d’un groupe ou d’un utilisateur, groupe/gladys-* ceux qui commencent par gladys-. |
| Intervalle de lecture (s) | number | Non | Fréquence de lecture de GitLab, entre 60 et 3600 secondes. C’est aussi le délai de réaction des déclencheurs de scène. |
| Langue des textes | select | Non | Noms des appareils, résumés et sorties des scènes. Automatique : la langue de votre tableau de bord, dès qu’un widget GitLab a été affiché. |
Comment installer GitLab dans Gladys
- Dans Gladys, ouvrez Intégrations : GitLab apparaît dans le catalogue, aux côtés des intégrations natives, avec un badge communautaire.
- Cliquez sur Installer. Gladys télécharge l'image Docker (
ghcr.io/william-de71/gladys-gitlab:0.1.0), la démarre dans un bac à sable isolé du cœur, et génère l'interface de l'intégration (appareils, découverte et configuration). - Ouvrez l'écran Configuration de l'intégration, remplissez les paramètres, puis enregistrez.
- Vous pouvez aussi l'installer directement depuis l'URL de son dépôt : https://github.com/William-De71/gladys-gitlab.
GitLab nécessite Gladys >=5.3.0. Le catalogue dans Gladys se rafraîchit toutes les heures : une nouvelle version est donc disponible au plus tard une heure après sa sortie.
Vous n'utilisez pas encore Gladys ? C'est gratuit et open source : suivez le guide d'installation pour démarrer.
À propos des intégrations externes
GitLab est une intégration externe : une intégration communautaire empaquetée dans un conteneur Docker et publiée sur GitHub, que Gladys installe en un clic et exécute dans un bac à sable isolé de son cœur. Elle est publiée et maintenue par William-De71, et non par l'équipe cœur de Gladys.
- Parcourir toutes les intégrations, natives et communautaires
- Créer et publier votre propre intégration externe
- Code source sur GitHub — source de cette documentation