Requisitos previos
- Un proyecto de Mintlify conectado a un repositorio de GitHub o GitLab
- Para GitHub: la aplicación de GitHub de Mintlify instalada en cada repositorio que planees usar en la automatización
- Para GitLab: una cuenta de GitLab conectada (consulta Configuración de GitLab más abajo)
Activar una automatización
- Abre la página Automatizaciones en tu dashboard.
- Haz clic en el interruptor junto a una automatización para activarla. Si la automatización puede ejecutarse con la configuración predeterminada, se activa de inmediato. De lo contrario, se abre la página de configuración de la automatización para que completes los ajustes obligatorios.
- Si se abre la página de configuración, completa los campos obligatorios y haz clic en Save.
Configuraciones
Activador
- Actualización de contenido: se ejecuta cada vez que envías contenido al repositorio de tu proyecto, incluidas las fusiones de pull requests y los pushes directos.
- Cambio de código: se ejecuta cuando se fusiona una pull request en un repositorio de código fuente conectado. Debes especificar al menos un repositorio de origen. Haz clic en Add repo para activar la automatización con pull requests de más de un repositorio. Para cada repositorio, puedes configurar opcionalmente Exclude author para ignorar pull requests de un autor específico, y Listening to changes in para activar el disparador solo con pull requests que tengan cambios bajo una ruta específica.
- Programación personalizada: se ejecuta de forma recurrente según la programación que definas. Elige un preajuste (Daily, Every Monday, Every Friday o Twice weekly) y una hora de inicio, o selecciona Custom cron e introduce una expresión cron estándar de 5 campos (
minute hour day month weekday). Las automatizaciones se ponen en cola dentro de los 10 minutos siguientes a la hora programada. - Integración: se ejecuta cuando ocurre un evento seleccionado en una integración compartida conectada, o cuando se publica un nuevo mensaje en un canal de Slack seleccionado. Está disponible para automatizaciones personalizadas. Selecciona la integración y el evento y completa los campos adicionales que aparezcan. Para activadores de Slack, elige uno o más canales a los que se haya añadido la app de Mintlify para Slack.
- Webhook: se ejecuta cuando una solicitud
POSTautenticada llega al endpoint de webhook de la automatización. Solo está disponible para automatizaciones personalizadas. Guarda primero la automatización. La tarjeta del activador muestra entonces la URL del webhook y una acción Copy auth header para el encabezadoAuthorization: Bearer <api-key>. Proporciona una clave de API de organización sin caducar con acceso de escritura desde la página API keys. Úsalo para lanzar una ejecución desde un pipeline de CI/CD, un script de publicación o una herramienta interna. Consulta Activar webhook de automatización para conocer el endpoint y los límites de tasa.
Filtrar activadores de cambio de código
- Listening to changes in: añade rutas que la pull request debe modificar para que se ejecute la automatización. Las rutas pueden ser archivos, carpetas o patrones glob (por ejemplo,
docs/**/*.mdx). Las sugerencias provienen de los archivos rastreados del repositorio; también puedes escribir una ruta personalizada. - Excluding PRs from: añade nombres de usuario de GitHub o cuentas de bot cuyas pull requests no deben activar la automatización. Es útil para omitir fusiones realizadas por cuentas de automatización. Las sugerencias provienen de los contribuidores recientes; también puedes escribir un nombre de usuario personalizado.
Modo de actualización
Para repositorios de GitHub, las actualizaciones automáticas requieren que la aplicación de GitHub de Mintlify tenga permisos de bypass en todos los rulesets que apunten a tu rama de implementación, incluidos los rulesets a nivel de organización y de repositorio. Consulta Configurar automerge para ver las instrucciones de configuración.Para repositorios de GitLab, el automerge utiliza la conexión OAuth de GitLab y requiere al menos el rol Maintainer en cada proyecto.
Repositorios de contexto
Integraciones
Notificaciones de Slack
- Instala la aplicación de Slack de Mintlify en tu espacio de trabajo.
- Haz clic en Configure Slack en la página Automatizaciones de tu dashboard.
- Selecciona uno o más canales a los que enviar notificaciones.
- Haz clic en Save changes.
- Una automatización abre una pull request para revisión.
- Una pull request de una automatización lleva tres días esperando revisión.
- Una automatización fusiona una pull request o no logra completarse.
Notificaciones por correo electrónico
Instrucciones
Idiomas de destino
- Mintlify lee los idiomas definidos en tu
docs.jsonpara identificar tu idioma predeterminado y preselecciona los idiomas de destino que ya estén configurados. - Debes seleccionar al menos un idioma de destino para guardar la automatización.
- No puedes seleccionar el idioma fuente como idioma de destino.
Configuración de GitLab
Las automatizaciones requieren un plan de pago de GitLab. El agente utiliza tokens de acceso de proyecto de corta duración para acceder a los repositorios, lo cual el plan gratuito de GitLab no admite.
Desactivar una automatización
- Ve a la página Automatizaciones en tu dashboard.
- Haz clic en el interruptor junto a una automatización para desactivarla.
Eliminar una automatización
- Abre la página Automatizaciones en tu dashboard.
- Haz clic en el botón de configuración en la tarjeta de la automatización personalizada para abrir su página de configuración.
- Haz clic en Delete automation en la parte inferior de la página y confirma.
Ejecutar una automatización manualmente
- Abre la página Automatizaciones en tu dashboard.
- Haz clic en el botón de configuración en la tarjeta de la automatización para abrir su página de configuración.
- Haz clic en el botón de ejecución (Test run o Run now, según la automatización).
- Elige el alcance de la ejecución.
- Since a date: Revisa los cambios desde la fecha seleccionada hasta el momento actual. La fecha predeterminada es la de la última ejecución de la automatización, o hace siete días si nunca se ha ejecutado.
- Everything: Revisa todo el sitio o el historial del repositorio. Este alcance suele tardar más que una ejecución dirigida.
- Specific pull request: Limita la ejecución a una sola pull request en un repositorio seleccionado.
- Haz clic en Run now.
Activar una automatización programada mediante la API
Activar una automatización de webhook
POST autenticada a su endpoint de webhook. Después de guardar la automatización, abre su página de configuración para copiar la URL del webhook y ver la plantilla del encabezado Authorization: Bearer <api-key>. Sustituye <api-key> por una clave de API de organización sin caducar con acceso de escritura, creada en la página API keys. Las automatizaciones no crean, almacenan ni rotan claves.
Las ejecuciones activadas por el webhook usan el prompt guardado de la automatización, leen el historial completo del repositorio y aparecen en el historial de ejecuciones con la etiqueta Webhook request. Consulta Activar webhook de automatización para conocer el formato de la solicitud, los códigos de respuesta y los límites de tasa.
Ver el historial de ejecuciones
- Abre la página Automatizaciones en tu dashboard.
- Usa los menús desplegables para filtrar por automatizaciones o estado específicos.
- Review needed: El agente finalizó la ejecución, pero alguien de tu equipo debe revisar y fusionar los cambios.
- Running: El agente está trabajando activamente en la tarea de la automatización.
- Accepted: El agente finalizó la ejecución y los cambios se fusionaron en tu repositorio.
- Closed: El agente finalizó la ejecución, pero alguien rechazó los cambios.
- Failed: El agente no pudo completar la ejecución.
- No action needed: El agente finalizó la ejecución pero no encontró nada que actualizar.
- Modified PR: El resultado agregó cambios a una pull request abierta por una ejecución anterior.