Usamos tokens de acceso y webhooks para autenticar y sincronizar cambios entre GitLab y Mintlify.
  • Mintlify usa tokens de acceso para obtener información de GitLab.
  • GitLab usa webhooks para notificar a Mintlify cuando se realizan cambios, lo que habilita despliegues de vista previa para las solicitudes de fusión.

​
Configura la conexión

1

Encuentra tu ID de proyecto

En tu proyecto de GitLab, ve a Settings > General y localiza tu Project ID.
La página General Settings en el panel de GitLab. El Project ID está resaltado.
2

Genera un token de acceso

Ve a Settings > Access Tokens y selecciona Add new token.Configura el token con estos parámetros:
  • Name: Mintlify
  • Role: Maintainer (requerido 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. Ten en cuenta que los Personal Access Tokens caducan y deben actualizarse.
La página Access Tokens en el panel de GitLab. Se resaltan los parámetros que configurar para Mintlify.
3

Configura la conexión

En el panel de Mintlify:
  1. Ingresa tu Project ID y Access Token.
  2. Completa cualquier otra configuración requerida.
  3. Haz clic en Save Changes.
La página Git Settings en el panel de Mintlify. Se resaltan las configuraciones de GitLab.

​
Crear el webhook

Los webhooks nos permiten recibir eventos cuando se realizan cambios para desencadenar despliegues automáticamente.
1

Ve a Settings > Webhooks y haz clic en 'Add new Webhook'

2

Configura la URL y el webhook

En el campo “URL”, introduce el endpoint https://leaves.mintlify.com/gitlab-webhook y asigna el nombre “Mintlify” al webhook.
3

Pega el token

Pega el token del webhook generado después de configurar la conexión.
4

Selecciona los eventos

Selecciona estos eventos para activar el webhook:
  • Push events (All branches)
  • Merge requests events
Cuando termines, debería verse así:
La página de Webhook en el panel de GitLab. Se resaltan los ajustes que debes configurar para Mintlify.
5

Prueba el webhook

Después de crear el webhook, haz clic en el menú desplegable “Test” y selecciona “Push events” para enviar un payload de ejemplo y verificar que esté configurado correctamente. Verás “Hook executed successfully: HTTP 200” si todo está bien.Esto te ayudará a confirmar que todo funciona correctamente y que tu documentación se sincroniza adecuadamente con tu repositorio de GitLab.