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 extraire des informations depuis GitLab.
  • GitLab utilise des webhooks pour avertir Mintlify lorsque des modifications sont apportées, ce qui permet des déploiements de prévisualisation pour les demandes de fusion.

​
Configurer la connexion

1

Trouver votre ID de projet

Dans votre projet GitLab, accédez à Settings > General et repérez votre Project ID.
La page General Settings dans le tableau de bord GitLab, avec le Project ID mis en surbrillance.
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 dépôts 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 à la place. Notez que les Personal Access Tokens expirent et doivent être mis à jour.
La page Access Tokens dans le tableau de bord GitLab, avec les paramètres à configurer pour Mintlify mis en surbrillance.
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 Save Changes.
La page Git Settings dans le tableau de bord Mintlify, avec les paramètres de configuration GitLab mis en surbrillance.

​
Créer le webhook

Les webhooks permettent de recevoir des événements lors de modifications 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 le point de terminaison 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é, vous devriez obtenir le résultat suivant :
La page Webhook dans le tableau de bord GitLab. Les paramètres à configurer pour Mintlify sont mis en évidence.
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 la bonne configuration. Le message « Hook executed successfully: HTTP 200 » s’affiche si tout est correct.Cela vous permettra de confirmer que tout fonctionne et que votre documentation se synchronisera correctement avec votre dépôt GitLab.