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>
99 lines
4.5 KiB
Plaintext
99 lines
4.5 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.png" alt="La página Git Settings en el Dashboard de Mintlify. La configuración de GitLab está destacada." />
|
|
</Frame>
|
|
</Step>
|
|
</Steps>
|
|
|
|
<div id="create-the-webhook">
|
|
## Crear el webhook
|
|
</div>
|
|
|
|
Los webhooks nos permiten recibir eventos cuando se realizan cambios y así
|
|
activar implementaciones automáticamente.
|
|
|
|
<Steps>
|
|
<Step title="Ve a Settings > Webhooks y 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="Configura la URL y el webhook">
|
|
En el campo "URL", ingresa el endpoint `https://leaves.mintlify.com/gitlab-webhook` y asigna al webhook el nombre "Mintlify".
|
|
|
|
</Step>
|
|
<Step title="Pega el token">
|
|
Pega el token del webhook generado después de configurar la conexión.
|
|
<Frame>
|
|
<img src="/images/gitlab/gitlab-show-webtoken.png" alt="Captura de pantalla de la conexión de GitLab en el Dashboard de Mintlify. El botón Show Webtoken está resaltado." />
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Selecciona los eventos">
|
|
Selecciona estos eventos para activar el webhook:
|
|
- **Push events** (All branches)
|
|
- **Merge requests events**
|
|
|
|
Cuando termines, debería verse así:
|
|
<Frame>
|
|
<img src="/images/gitlab/gitlab-project-webtoken.png" alt="La página de Webhook en el dashboard de GitLab. Los ajustes para configurar Mintlify están resaltados." />
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Prueba el webhook">
|
|
Después de crear el webhook, haz clic en el menú desplegable "Test" y selecciona "Push events" para enviar una carga de ejemplo y asegurarte de que esté configurado correctamente. Verás el mensaje "Hook executed successfully: HTTP 200" si todo está bien.
|
|
|
|
Esto te ayudará a verificar que todo funcione correctamente y que tu documentación se sincronice correctamente con tu repositorio de GitLab.
|
|
<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> |