mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
a4d84dbcbc
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
151 lines
7.3 KiB
Plaintext
151 lines
7.3 KiB
Plaintext
---
|
|
title: "GitLab"
|
|
description: "Conecta tu repositorio de GitLab a Mintlify para despliegues automáticos, vistas previas de merge requests y sincronización continua."
|
|
keywords: ["Integración con GitLab", "tokens de acceso", "vistas previas de merge request", "autoalojado", "instancia"]
|
|
boost: 3
|
|
---
|
|
|
|
Mintlify usa 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 realizas cambios, lo que habilita implementaciones de vista previa para las merge requests.
|
|
|
|
<div id="set-up-the-connection">
|
|
## Configura la conexión
|
|
</div>
|
|
|
|
Cuando abras [Git Settings](https://app.mintlify.com/settings/deployment/git-settings) por primera vez, un asistente de configuración te guía a través de la conexión de tu repositorio de GitLab.
|
|
|
|
<Steps>
|
|
<Step title="Select GitLab as your provider">
|
|
En la página de [Git Settings](https://app.mintlify.com/settings/deployment/git-settings), selecciona **Connect to GitLab** y haz clic en **Continue**.
|
|
</Step>
|
|
<Step title="Download your content">
|
|
<Tip>
|
|
Si ya tienes un repositorio de GitLab con tu documentación, puedes omitir la descarga y hacer clic en **Continue setup** directamente.
|
|
</Tip>
|
|
|
|
Si tu documentación está alojada en Mintlify, descárgala como un archivo zip.
|
|
* Crea un nuevo repositorio en GitLab.
|
|
* Extrae el contenido del zip.
|
|
* Sube el contenido a tu repositorio.
|
|
|
|
Haz clic en **Continue setup** para continuar.
|
|
</Step>
|
|
<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="Connect your repository">
|
|
De vuelta en el asistente de configuración, completa los siguientes campos:
|
|
|
|
- **GitLab instance URL**: Déjalo en blanco para `gitlab.com`, o ingresa la URL de tu instancia autoalojada (por ejemplo, `https://gitlab.your-domain.com`). Tu instancia debe ser accesible públicamente para que Mintlify pueda conectarse.
|
|
- **Project ID**: El ID del proyecto de la configuración de tu proyecto de GitLab.
|
|
- **GitLab deployment token**: El token de acceso que generaste.
|
|
- **Branch**: Selecciona la rama desde la cual desplegar tu documentación.
|
|
|
|
Haz clic en **Connect**.
|
|
<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="update-an-existing-connection">
|
|
## Actualizar una conexión existente
|
|
</div>
|
|
|
|
Para modificar la configuración de tu conexión con GitLab después de la configuración inicial, ve a [Git Settings](https://app.mintlify.com/settings/deployment/git-settings) y actualiza tu ID de proyecto, token de acceso, rama o URL de instancia directamente.
|
|
|
|
<div id="create-the-webhook">
|
|
## Volver a validar la configuración de Git
|
|
|
|
Si tu despliegue muestra un comportamiento inesperado, como opciones de rama faltantes o una configuración desactualizada, puedes forzar a Mintlify a actualizar tu origen de Git.
|
|
|
|
<Steps>
|
|
<Step title="Ir a Git Settings">
|
|
Ve a [Git Settings](https://app.mintlify.com/settings/deployment/git-settings) en tu Dashboard.
|
|
</Step>
|
|
<Step title="Volver a validar la configuración">
|
|
Haz clic en la insignia verde **Active** en la esquina del recuadro de configuración de GitLab para volver a validar tu origen de Git. Un toast de éxito confirma cuando se completa la revalidación, y aparece un toast de error si tu configuración necesita revisión.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Crear el webhook
|
|
</div>
|
|
|
|
Los webhooks notifican a Mintlify cuando envías cambios, para que las implementaciones se activen 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`, configuraste el webhook 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>
|