mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
7aea6b1b61
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
114 lines
5.2 KiB
Plaintext
114 lines
5.2 KiB
Plaintext
---
|
|
title: "GitLab"
|
|
description: "Conecta un repositorio de GitLab para implementaciones automatizadas y compilaciones de vista previa."
|
|
keywords: ["Integración con GitLab", "tokens de acceso", "vistas previas de merge request"]
|
|
---
|
|
|
|
Usamos tokens de acceso y webhooks para autenticar y sincronizar cambios entre GitLab y Mintlify.
|
|
|
|
- Mintlify usa tokens de acceso para extraer información de GitLab.
|
|
- GitLab usa webhooks para notificar a Mintlify cuando se realizan cambios, habilitando implementaciones de vista previa para las merge requests.
|
|
|
|
<div id="set-up-the-connection">
|
|
## Configura la conexión
|
|
</div>
|
|
|
|
<Note>
|
|
**Se requiere clonación por HTTPS**: Tu proyecto de GitLab debe tener habilitada la clonación por HTTPS para que Mintlify pueda acceder a tu repositorio. Puedes verificarlo en GitLab yendo a **Settings** > **General** > la sección **Visibility and access controls** de tu proyecto.
|
|
</Note>
|
|
|
|
<Steps>
|
|
<Step title="Find your project ID">
|
|
En tu proyecto de GitLab, ve a **Settings** > **General** y ubica tu **Project ID**.
|
|
<Frame>
|
|
<img src="/images/gitlab/gitlab-project-id.png" alt="La página General Settings en el dashboard de GitLab. El Project ID está destacado." />
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Generate an access token">
|
|
Ve a **Settings** > **Access Tokens** y selecciona **Add new token**.
|
|
|
|
Configura el token con estos parámetros:
|
|
- **Name**: Mintlify
|
|
- **Role**: Maintainer (obligatorio para repos privados)
|
|
- **Scopes**: `api` y `read_api`
|
|
|
|
Haz clic en **Create project access token** y copia el token.
|
|
|
|
<Note>
|
|
Si los Project Access Tokens no están disponibles, puedes usar un Personal Access Token en su lugar. Ten en cuenta que los Personal Access Tokens caducan y deben actualizarse.
|
|
</Note>
|
|
|
|
<Frame>
|
|
<img src="/images/gitlab/gitlab-project-access-token.png" alt="La página Access tokens en el dashboard de GitLab. Los parámetros a configurar para Mintlify están destacados." />
|
|
</Frame>
|
|
|
|
</Step>
|
|
<Step title="Set up the connection">
|
|
En el [Dashboard de Mintlify](https://dashboard.mintlify.com/settings/deployment/git-settings):
|
|
1. Ingresa tu Project ID y el access token.
|
|
2. Completa cualquier otra configuración obligatoria.
|
|
3. Haz clic en **Guardar cambios**.
|
|
<Frame>
|
|
<img src="/images/gitlab/gitlab-config-light.png" alt="El panel de configuración de GitLab en la página Git Settings del Dashboard de Mintlify." className="block dark:hidden" />
|
|
<img src="/images/gitlab/gitlab-config-dark.png" alt="El panel de configuración de GitLab en la página Git Settings del Dashboard de Mintlify." className="hidden dark:block" />
|
|
</Frame>
|
|
</Step>
|
|
</Steps>
|
|
|
|
<div id="create-the-webhook">
|
|
## Crear el webhook
|
|
</div>
|
|
|
|
Los webhooks nos permiten recibir eventos cuando se realizan cambios, para poder activar las implementaciones automáticamente.
|
|
|
|
<Steps>
|
|
<Step title="Agregar nuevo webhook">
|
|
1. En GitLab, ve a **Settings** > **Webhooks**.
|
|
2. Haz clic en **Add new webhook**.
|
|
<Frame>
|
|
<img src="/images/gitlab/gitlab-webhook.png" alt="Captura de pantalla de la página de Webhooks en el dashboard de GitLab." />
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Configurar la URL y el webhook">
|
|
Asigna al webhook el nombre **Mintlify**.
|
|
|
|
En el campo **URL**, introduce el endpoint `https://leaves.mintlify.com/gitlab-webhook`.
|
|
</Step>
|
|
<Step title="Obtener el webtoken">
|
|
En tu Dashboard de Mintlify, haz clic en **Show Webtoken**. Copia el webtoken.
|
|
<Frame>
|
|
<img src="/images/gitlab/show-webtoken-light.png" alt="Captura de pantalla de la conexión de GitLab en el Dashboard de Mintlify." className="block dark:hidden" />
|
|
<img src="/images/gitlab/show-webtoken-dark.png" alt="Captura de pantalla de la conexión de GitLab en el Dashboard de Mintlify." className="hidden dark:block" />
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Pegar el webtoken">
|
|
En GitLab, pega el webtoken desde tu Dashboard de Mintlify en el campo **Secret token**.
|
|
</Step>
|
|
<Step title="Seleccionar eventos">
|
|
Selecciona los siguientes eventos para activar el webhook:
|
|
- **Push events** (All branches)
|
|
- **Merge requests events**
|
|
</Step>
|
|
<Step title="Verificar el webhook">
|
|
Deberías ver la siguiente configuración después de configurar el webhook:
|
|
|
|
- **Name**: Mintlify
|
|
- **URL**: `https://leaves.mintlify.com/gitlab-webhook`
|
|
- **Secret token**: el webtoken de tu Dashboard de Mintlify
|
|
- **Events**: **Push events** (All branches) y **Merge requests events**
|
|
|
|
Añade el webhook.
|
|
|
|
<Frame>
|
|
<img src="/images/gitlab/gitlab-project-webtoken.png" alt="La página de Webhooks en el dashboard de GitLab. La configuración que se debe establecer para Mintlify está resaltada." />
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Probar el webhook">
|
|
Después de crear el webhook, haz clic en el menú desplegable **Test**. Haz clic en **Push events** para enviar un payload de prueba. Si la prueba devuelve `Hook executed successfully: HTTP 200`, tu webhook está configurado correctamente.
|
|
|
|
<Frame>
|
|
<img src="/images/gitlab/gitlab-project-webtoken-test.png" alt="Captura de pantalla de la página de Webhooks de GitLab. El elemento de menú 'Push events' está resaltado en el menú 'Test'." />
|
|
</Frame>
|
|
|
|
</Step>
|
|
</Steps> |