Passer au contenu principal
Nous utilisons 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 des changements sont effectués, ce qui permet de créer des déploiements de prévisualisation pour les demandes de fusion.

​
Configurer la connexion

1

Find your project ID

Dans votre projet GitLab, allez dans Settings > General et repérez votre Project ID.
La page General Settings du tableau de bord GitLab. Le Project ID est mis en évidence.
2

Generate an access token

Allez dans 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 renouvelés.
La page Access Tokens du tableau de bord GitLab. Les paramètres à configurer pour Mintlify sont mis en évidence.
3

Set up the connection

Dans le Mintlify dashboard :
  1. Saisissez votre Project ID et votre access token.
  2. Renseignez les autres paramètres requis.
  3. Cliquez sur Save Changes.
La page Git Settings dans le tableau de bord Mintlify. Les paramètres de configuration GitLab sont mis en évidence.

​
Créer le webhook

Les webhooks nous 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 l’endpoint https://leaves.mintlify.com/gitlab-webhook et nommez le webhook « Mintlify ».
3

Coller le jeton

Collez le jeton du 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 (All 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’affichera si tout est correct.Cela vous aidera à vérifier que tout fonctionne et que votre documentation se synchronise correctement avec votre dépôt GitLab.