GitLab

Synchronisez votre documentation avec un dépôt GitLab

Nous utilisons des jetons d’accès et des webhooks pour authentifier et synchroniser les modifications 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 des modifications sont effectuées, ce qui permet des déploiements de prévisualisation pour les demandes de fusion.

​

Configurer la connexion

Clonage HTTPS requis : votre projet GitLab doit avoir le clonage HTTPS activé pour que Mintlify puisse accéder à votre référentiel. Vous pouvez le vérifier dans GitLab en allant dans les Settings de votre projet > General > Visibility and access controls.

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. Renseignez les autres configurations requises.
   3. Cliquez sur Enregistrer les modifications.

   

​

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. Accédez à Settings > Webhooks et cliquez sur « Add new Webhook »

   
2. Configurer l’URL et le webhook

   Dans le champ « URL », saisissez l’endpoint https://leaves.mintlify.com/gitlab-webhook et nommez le webhook « Mintlify ».

3. Coller le jeton

   Collez le jeton de webhook généré après la configuration de la connexion.

   
4. Sélectionner les événements

   Sélectionnez ces événements pour déclencher le webhook :

   • Push events (toutes les branches)
   • Merge requests events

   Une fois terminé, cela devrait ressembler à ceci :

   
5. Tester le webhook

   Après avoir créé le webhook, cliquez sur le menu déroulant « Test » et sélectionnez « Push events » pour envoyer une charge utile d’exemple et vérifier qu’il est correctement configuré. Un message « Hook executed successfully: HTTP 200 » s’affichera si tout est correctement configuré.

   Cela vous aidera à vérifier que tout fonctionne correctement et que votre documentation se synchronise correctement avec votre référentiel GitLab.