Gitlab
Généralités
Nous utilisons GitLab CE pour notre documentation et notre suivi de maintenance.
Utilisation de l’outil
Cet outil est composé par projet :
Il est donc important de sélectionner le bon projet pour accéder aux données recherchées.
Documentation
Toute notre documentation est regroupée dans le wiki du projet TeDomum / Documentation :
Une fois le wiki ouvert, vous aurez une page similaire :
En cas d’erreur ou de suggestion de modification sur une de nos documentations, n’hésitez pas à nous en faire part sur matrix ou à créer un ticket, voir chapitre ci-dessous.
Gestion de la partie support (tickets)
Consultation des tickets
Les tickets sont gérés par projet. Pour y accéder, il faut donc sélectionner un projet. Exemple avec PeerTube :
En cliquant sur le menu liste, vous obtiendrez une page similaire à celle ci-dessous :
Comme vous pourrez le voir, les tickets possèdent différentes étiquettes pour identifier rapidement s’il s’agit d’un bug, d’une suggestion, d’une mise à jour, etc. Si vous ne souhaitez voir que les tickets pour une étiquette donnée (bug par exemple), il suffit de cliquer sur l’étiquette concernée pour afficher tous les tickets du même style :
Il est également possible de générer un tableau de bord pour les tickets afin de voir facilement dans quelle catégorie ils sont classés :
Pour avoir cette page, il suffit d’aller dans le menu Ticket > Tableau.
Il reste possible d’afficher l’ensemble de tous les tickets ouverts (tous projets confondus).
Création d’un ticket
Pour créer un ticket, il faut tout d’abord sélectionner le projet pour lequel un ticket doit être ouvert. Par exemple, si vous rencontrez un problème avec PixelFed, il suffit alors de sélectionner le projet TeDomum / Pixelfed, d’aller dans la partie tickets et de cliquer ensuite sur New Issue :
Vous aurez alors le formulaire ci-dessous à remplir :
Dans le cas d’une suggestion pour la mise en place d’un service n’existant pas chez TeDomum, nous vous invitons à ouvrir un ticket dans la partie Documentation.
Créer son propre projet
Après vous être connecté via Hiboo, une page listant les projets publics (ou privés auxquels vous avez accès) s’affichera. Si vous souhaitez créer votre propre projet, il suffit alors de cliquer sur le bouton New project :
Ce qui vous ouvrira la page suivante :
À partir de là, vous pouvez choisir entre :
- créer un projet vierge où il faudra tout créer ;
- partir sur un template qui préconfigurera le projet ;
- importer un projet venant d’ailleurs pour en avoir une copie conforme ;
- suivre les instructions pour créer un projet via votre terminal.
Changer la langue sur Gitlab
Lorsque vous aurez créé votre compte, il vous sera possible de changer la langue de Gitlab dans les paramètres de votre compte.
À noter que la traduction est loin d’être complète pour le moment.
Installer un Runner Gitlab Ci
La forge Gitlab intègre un support d’intégration continue via Gitlab CI. Afin de construire votre projet, vous pouvez au choix :
- utiliser un build reposant sur une image Docker et construire grâce au runner Docker partagé disponible pour tous les projets (vous ne pourrez en revanche pas l’utiliser pour construire une image Docker) ;
- nous solliciter pour utiliser un runner restreint, sous réserve d’acceptation par les administrateurs, notamment de garanties sur les tâches lancées sur ces runners ;
- utiliser votre propre runner.
Afin d’installer un runner, suivez d’abord les instructions à cette adresse : https://docs.gitlab.com/runner/install/. Nous recommandons une installation sur une machine virtuelle Debian 10 au minimum et le déploiement via le dépôt APT de Gitlab.
Puis, démarrez la commande gitlab-runner register et répondez aux questions suivantes :
- serveur :
https://forge.tedomum.net/; - token : utilisez le token de l’un de vos dépôts, idéalement du premier dépôt pour lequel vous souhaitez tester ;
- mode :
shell(le principal mode que nous supportons).
Pour construire d’autres projets avec ce runner, merci de contacter un administrateur afin qu’il active le runner sur ces autres projets. Si tous les projets que vous souhaitez construire sont dans un même groupe Gitlab, vous pouvez également enregistrer le runner avec un token de groupe ; en revanche, il ne pourra plus être activé sur un projet en dehors de ce groupe, même par un administrateur.
Si vous souhaitez construire des images Docker, vous pouvez activer le mode AutoDevops de Gitlab, paramétré sur notre forge exclusivement pour construire et publier sur le dépôt Gitlab les images Docker des projets. Afin que la construction réussisse, il est nécessaire que Docker soit installé sur la machine où vous construisez l’image et que l’utilisateur gitlab-runner puisse exécuter des conteneurs Docker. Reportez-vous à la documentation Docker à ce sujet.
Autres instances
Il existe d’autres instances Gitlab. Si vous ne trouvez pas votre bonheur chez nous, peut-être le trouverez-vous ailleurs ? Ci-dessous une liste d’instances :
À noter que vous en trouverez certainement d’autres du côté des chatons.