GitLab

Connectez un référentiel GitLab pour des déploiements automatisés et des prévisualisations de builds.

Mintlify utilise des jetons d’accès et des webhooks pour authentifier et synchroniser les changements entre GitLab et Mintlify.

• Mintlify utilise des jetons d’accès pour récupérer des informations depuis GitLab.
• GitLab utilise des webhooks pour avertir Mintlify lorsque vous effectuez des changements, ce qui permet des déploiements de prévisualisation pour les merge requests.

​

Configurer la connexion

1. Trouver votre ID de projet

   Dans votre projet GitLab, accédez à Settings > General et repérez votre Project ID.

   
2. Générer un jeton d'accès

   Accédez à Settings > Access Tokens et sélectionnez Add new token.

   Configurez le jeton avec les paramètres suivants :

   • Name : Mintlify
   • Role : Maintainer (requis pour les référentiels privés)
   • Scopes : api et read_api

   Cliquez sur Create project access token et copiez le jeton.

   Si les Project Access Tokens ne sont pas disponibles, vous pouvez utiliser un Personal Access Token. Notez que les Personal Access Tokens expirent et doivent être renouvelés.

   
3. Configurer la connexion

   Dans le Tableau de bord Mintlify :

   1. Saisissez votre ID de projet et votre jeton d’accès.
   2. Si vous avez un monorepo et que votre documentation ne se trouve pas à la racine de votre référentiel, activez le toggle Set up as monorepo et saisissez le chemin relatif vers votre répertoire de documentation.
   3. Si vous utilisez une instance GitLab auto-hébergée, activez l’option Set up as self-hosted et saisissez l’URL hôte de votre instance GitLab (par exemple, https://gitlab.your-domain.com). Votre instance doit être accessible publiquement pour que Mintlify puisse s’y connecter.
   4. Sélectionnez la branche à partir de laquelle déployer votre documentation.
   5. Cliquez sur Save Changes.

   

​

Créer le webhook

Les webhooks nous permettent de recevoir des événements lorsque des modifications sont effectuées afin de déclencher automatiquement des déploiements.

1. Ajouter un nouveau webhook

   1. Dans GitLab, accédez à Settings > Webhooks.
   2. Cliquez sur Add new webhook.

   
2. Configurer l'URL et le webhook

   Nommez le webhook Mintlify.

   Dans le champ URL, saisissez le point de terminaison https://leaves.mintlify.com/gitlab-webhook.

3. Récupérer le webtoken

   Dans votre Tableau de bord Mintlify, cliquez sur Show Webtoken. Copiez le webtoken.

   
4. Coller le webtoken

   Dans GitLab, collez le webtoken depuis votre Tableau de bord Mintlify dans le champ Secret token.

5. Sélectionner les événements

   Sélectionnez les événements suivants pour déclencher le webhook :

   • Push events (All branches)
   • Merge requests events
6. Vérifier le webhook

   Vous devriez voir les paramètres suivants après avoir configuré le webhook :

   • Name : Mintlify
   • URL : https://leaves.mintlify.com/gitlab-webhook
   • Secret token : le webtoken depuis votre Tableau de bord Mintlify
   • Events : Push events (All branches) et Merge requests events

   Ajoutez le webhook.

   
7. Tester le webhook

   Après avoir créé le webhook, cliquez sur le menu déroulant Test. Cliquez sur Push events pour envoyer un payload d’exemple. Si le test renvoie Hook executed successfully: HTTP 200, votre webhook est correctement configuré.