GitLab

Conecta un repositorio de GitLab para implementaciones automatizadas y compilaciones de vista previa.

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.

​

Configura la conexión

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.

1. Find your project ID

   En tu proyecto de GitLab, ve a Settings > General y ubica tu Project ID.

   
2. 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.

   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.

   
3. Set up the connection

   En el Dashboard de Mintlify:

   1. Ingresa tu Project ID y el access token.
   2. Completa cualquier otra configuración obligatoria.
   3. Haz clic en Guardar cambios.

   

​

Crear el webhook

Los webhooks nos permiten recibir eventos cuando se realizan cambios, para poder activar las implementaciones automáticamente.

1. Agregar nuevo webhook

   1. En GitLab, ve a Settings > Webhooks.
   2. Haz clic en Add new webhook.

   
2. 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.

3. Obtener el webtoken

   En tu Dashboard de Mintlify, haz clic en Show Webtoken. Copia el webtoken.

   
4. Pegar el webtoken

   En GitLab, pega el webtoken desde tu Dashboard de Mintlify en el campo Secret token.

5. Seleccionar eventos

   Selecciona los siguientes eventos para activar el webhook:

   • Push events (All branches)
   • Merge requests events
6. 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.

   
7. 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.