mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
bbb1a08ed3
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
98 lines
4.8 KiB
Plaintext
98 lines
4.8 KiB
Plaintext
---
|
||
title: "GitLab"
|
||
description: "Connectez un référentiel GitLab pour des déploiements automatisés et des prévisualisations de builds."
|
||
keywords: ["intégration GitLab", "jetons d’accès", "aperçus des merge requests"]
|
||
---
|
||
|
||
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 des déploiements de prévisualisation pour les merge requests.
|
||
|
||
<div id="set-up-the-connection">
|
||
## Configurer la connexion
|
||
</div>
|
||
|
||
<Note>
|
||
**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**.
|
||
</Note>
|
||
|
||
<Steps>
|
||
<Step title="Trouver votre ID de projet">
|
||
Dans votre projet GitLab, accédez à **Settings** > **General** et repérez votre **Project ID**.
|
||
<Frame>
|
||
<img src="/images/gitlab/gitlab-project-id.png" alt="La page General Settings dans le tableau de bord GitLab. Le Project ID est mis en évidence." />
|
||
</Frame>
|
||
</Step>
|
||
<Step title="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.
|
||
|
||
<Note>
|
||
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.
|
||
</Note>
|
||
|
||
<Frame>
|
||
<img src="/images/gitlab/gitlab-project-access-token.png" alt="La page Access Tokens dans le tableau de bord GitLab. Les paramètres à configurer pour Mintlify sont mis en évidence." />
|
||
</Frame>
|
||
|
||
</Step>
|
||
<Step title="Configurer la connexion">
|
||
Dans le [Tableau de bord Mintlify](https://dashboard.mintlify.com/settings/deployment/git-settings) :
|
||
1. Saisissez votre ID de projet et votre jeton d'accès.
|
||
2. Renseignez les autres configurations requises.
|
||
3. Cliquez sur **Enregistrer les modifications**.
|
||
<Frame>
|
||
<img src="/images/gitlab/gitlab-config.png" alt="La page Git Settings dans le Tableau de bord Mintlify. Les paramètres de configuration GitLab sont mis en évidence." />
|
||
</Frame>
|
||
</Step>
|
||
</Steps>
|
||
|
||
<div id="create-the-webhook">
|
||
## Créer le webhook
|
||
</div>
|
||
|
||
Les webhooks nous permettent de recevoir des événements lorsque des modifications sont effectuées, afin de déclencher automatiquement des déploiements.
|
||
|
||
<Steps>
|
||
<Step title="Accédez à Settings > Webhooks et cliquez sur « Add new Webhook »">
|
||
<Frame>
|
||
<img src="/images/gitlab/gitlab-webhook.png" alt="Capture d’écran de la page Webhooks dans le tableau de bord GitLab." />
|
||
</Frame>
|
||
</Step>
|
||
<Step title="Configurer l’URL et le webhook">
|
||
Dans le champ « URL », saisissez l’endpoint `https://leaves.mintlify.com/gitlab-webhook` et nommez le webhook « Mintlify ».
|
||
|
||
</Step>
|
||
<Step title="Coller le jeton">
|
||
Collez le jeton de webhook généré après la configuration de la connexion.
|
||
<Frame>
|
||
<img src="/images/gitlab/gitlab-show-webtoken.png" alt="Capture d’écran de la connexion GitLab dans le Tableau de bord Mintlify. Le bouton Show Webtoken est mis en évidence." />
|
||
</Frame>
|
||
</Step>
|
||
<Step title="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 :
|
||
<Frame>
|
||
<img src="/images/gitlab/gitlab-project-webtoken.png" alt="La page Webhooks dans le tableau de bord GitLab. Les paramètres à configurer pour Mintlify sont mis en évidence." />
|
||
</Frame>
|
||
</Step>
|
||
<Step title="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.
|
||
<Frame>
|
||
<img src="/images/gitlab/gitlab-project-webtoken-test.png" alt="Capture d’écran de la page GitLab Webhooks. L’élément de menu « Push events » est mis en évidence dans le menu « Test »." />
|
||
</Frame>
|
||
|
||
</Step>
|
||
</Steps> |