Saltar al contenido principal
Los flujos de trabajo ejecutan el agente automáticamente según una programación o cuando se hace un push a un repositorio. Cada flujo de trabajo define un prompt para el agente y un desencadenante para indicar cuándo ejecutarlo. Los flujos de trabajo son compatibles con repositorios de GitHub y GitLab. Cuando se ejecuta un flujo de trabajo, el agente clona los repositorios especificados como contexto, sigue el prompt y abre una solicitud de extracción (o solicitud de fusión en GitLab) o puede enviar los cambios directamente a tu rama de implementación. Cada flujo de trabajo puede ejecutarse hasta 50 veces al día. Las ejecuciones que fallan no cuentan para este límite.
Usa flujos de trabajo que se ejecutan según una programación para automatizar tareas recurrentes, como publicar registros de cambios o comprobar problemas de gramática y estilo.Usa flujos de trabajo que se ejecutan en eventos de push para automatizar tareas de mantenimiento reactivas, como actualizar referencias de API o identificar actualizaciones de documentación necesarias para nuevas funciones.

Crear un flujo de trabajo

  1. Abre la página Workflows.
  2. Haz clic en New workflow.
  3. Configura el nombre del flujo de trabajo, el tipo de disparador, los repositorios y la programación.
  4. Escribe las instrucciones del agente y elige si deseas fusionar automáticamente las solicitudes de extracción.
  5. Opcionalmente, habilita las notificaciones de Slack para cuando el flujo de trabajo se complete.
  6. Haz clic en Create workflow.
La página de configuración del nuevo flujo de trabajo.

Configuración

CampoObligatorioDescripción
NameNombre para mostrar que se muestra en el dashboard.
TriggerConfiguración del disparador.
ContextNoRepositorios clonados como referencia cuando se ejecuta el flujo de trabajo.
AutomergeNoDesactivado de forma predeterminada, lo que abre una solicitud de extracción para revisión. Si se habilita, abre una solicitud de extracción y la fusiona automáticamente.
NotifyNoConfiguración de notificaciones. Envía mensajes de Slack cuando se completen los flujos de trabajo.
Para repositorios de GitHub, debes tener instalada la aplicación de GitHub de Mintlify en cada repositorio enumerado en los campos de contexto o disparador. Agrega nuevos repositorios en la página de la aplicación de GitHub de tu dashboard de Mintlify. Para repositorios de GitLab, debes conectar tu cuenta de GitLab en la página de GitLab OAuth de tu dashboard de Mintlify. Luego agrega los repositorios que deseas usar con los flujos de trabajo. Debes tener al menos el rol de Maintainer en cada proyecto para conectar GitLab OAuth.
La página de la aplicación de GitHub que muestra los repositorios conectados de dos organizaciones.

Disparadores

Cada flujo de trabajo debe definir un único disparador.

Según programación (cron)

Ejecuta un flujo de trabajo de forma recurrente usando una expresión cron. Todas las ejecuciones programadas se realizan en UTC. Los flujos de trabajo se ponen en cola dentro de los 10 minutos siguientes a la hora programada y pueden tardar hasta 10 minutos en ejecutarse. El valor es una expresión cron estándar de 5 campos con el formato minute hour day-of-month month day-of-week. Utiliza una herramienta como crontab.guru para crear y validar los horarios.
ExpresiónProgramación
0 9 * * 1Todos los lunes a las 9:00 AM UTC
0 0 1 * *El primer día de cada mes a medianoche UTC
0 8 * * 1-5Días laborables a las 8:00 AM UTC

En eventos de push

Ejecuta un flujo de trabajo cuando se envían cambios a un repositorio o branch específicos. Esto incluye tanto fusiones de solicitudes de extracción como envíos directos al branch. Especifica cada repositorio en formato owner/repo. Opcionalmente, especifica un branch a supervisar. Si no especificas un branch, el flujo de trabajo se activa cuando se realizan pushes al branch predeterminado del repositorio. Un flujo de trabajo puede supervisar pushes en hasta 10 repositorios o branches.

Repositorios de contexto

Los repositorios de contexto otorgan al agente acceso de lectura a repositorios adicionales cuando se ejecuta el flujo de trabajo. Esto es útil cuando tu prompt requiere revisar código o contenido fuera de tu repositorio de documentación. Puedes especificar hasta cinco repositorios de contexto por flujo de trabajo.

Combinación automática de cambios

De forma predeterminada, el agente abre una solicitud de extracción por cada ejecución del flujo de trabajo para que puedas revisar los cambios antes de que se publiquen. Habilita la combinación automática para fusionar automáticamente la solicitud de extracción sin necesidad de aprobación manual. Esto te proporciona un registro de los cambios en el historial de solicitudes de extracción de tu repositorio, a la vez que automatiza el paso de fusión.
Para repositorios de GitHub, la función automerge requiere que la aplicación GitHub de Mintlify tenga permisos de bypass en todos los rulesets que apunten a tu rama de implementación, incluyendo rulesets a nivel de organización y a nivel de repositorio. Consulta Configurar automerge para ver las instrucciones de configuración.Para repositorios de GitLab, la función automerge utiliza la conexión GitLab OAuth configurada en la página de GitLab OAuth de tu dashboard de Mintlify. Debes tener al menos el rol de Maintainer en cada proyecto para conectar GitLab OAuth.

Notificaciones de Slack

Envía mensajes de Slack cuando un flujo de trabajo finalice o falle. Las notificaciones incluyen el estado del flujo de trabajo, un enlace a la solicitud de extracción y un resumen de los cambios.
Las notificaciones de Slack requieren la aplicación Mintlify Slack en el espacio de trabajo de Slack de tu organización. Instala la aplicación de Slack desde tu dashboard.
Al crear o editar un flujo de trabajo en el dashboard, habilita las notificaciones de Slack en el interruptor Notify on completion:
  1. Si aún no has conectado Slack, haz clic en Install Slack app.
  2. Haz clic en el interruptor Notify on completion.
  3. Busca y selecciona los canales a los que deseas notificar.
  4. Guarda tu flujo de trabajo.

Gestionar flujos de trabajo

Edita, elimina, deshabilita o activa flujos de trabajo desde la página Workflows en tu dashboard.

Activar un flujo de trabajo manualmente

Puedes ejecutar flujos de trabajo basados en cron bajo demanda sin esperar a la siguiente hora programada. Las ejecuciones activadas manualmente cuentan para el límite diario de ejecuciones.
  1. Ve a la página Workflows en tu dashboard.
  2. Haz clic en View workflows para ver todos los flujos de trabajo.
  3. Haz clic en el flujo de trabajo que deseas ejecutar.
  4. Haz clic en el botón de activación manual del flujo de trabajo para ejecutarlo.

Deshabilitar un flujo de trabajo

Deshabilita un flujo de trabajo para detenerlo temporalmente sin eliminarlo. Los flujos de trabajo deshabilitados conservan su configuración e historial de ejecuciones, pero no se ejecutan según su programación ni en respuesta a eventos push. No se puede activar manualmente un flujo de trabajo deshabilitado. Para activar o desactivar un flujo de trabajo:
  1. Ve a la página Workflows en tu dashboard.
  2. Haz clic en View workflows para ver todos los flujos de trabajo.
  3. Haz clic en el flujo de trabajo que deseas deshabilitar o habilitar.
  4. Haz clic en el interruptor Active para desactivar el flujo de trabajo, o actívalo para habilitarlo.
  5. Haz clic en Save changes.
Cuando vuelves a habilitar un flujo de trabajo basado en cron, Mintlify recalcula el próximo tiempo de ejecución a partir de la hora actual.

Configuración de GitLab

Para usar repositorios de GitLab en un flujo de trabajo, conecta cada proyecto a través de la integración OAuth de GitLab en la página de configuración OAuth de GitLab. Debes conectar todos los repositorios que utilice el flujo de trabajo, incluyendo tu repositorio de documentación y cualquier repositorio de activación o contexto.
Los flujos de trabajo requieren un plan de pago de GitLab. El agente utiliza tokens de acceso de proyecto de corta duración para acceder al repositorio, algo que el plan gratuito de GitLab no admite.

Prompts

Los prompts eficaces se centran en una sola tarea y buscan un resultado concreto. Los flujos de trabajo siempre presentan cierta variabilidad debido a la naturaleza no determinista de los agentes, pero puedes mejorar la consistencia de sus resultados siguiendo estas buenas prácticas:
  • Describe el resultado que quieres que el agente consiga.
  • Incluye criterios de éxito.
  • Especifica el contexto que quieres que el agente utilice.
  • Divide las tareas complejas en pasos o en varios flujos de trabajo.

Entorno del agente

El agente se ejecuta en un sandbox aislado. Al redactar prompts, solo haz referencia a las herramientas disponibles para el agente.
  • Utilidades estándar de shell (grep, sed, awk, curl y otras)
  • git y la CLI de GitHub (gh)
  • La CLI de Mintlify (mint)
  • Node.js y Bun
  • Búsqueda web para encontrar información actualizada fuera de tu documentación
  • Obtención web para recuperar y leer el contenido de una página web
El agente no puede instalar paquetes ni herramientas adicionales en tiempo de ejecución. No se puede acceder a los repositorios de paquetes desde el sandbox. Los prompts que indican al agente que ejecute herramientas no disponibles pueden producir resultados inesperados o fallar.

Ejemplos de prompts

Estos ejemplos de prompts demuestran patrones comunes de flujos de trabajo. Crea un flujo de trabajo en el dashboard y pega el prompt en el campo de instrucciones.

Borrador de documentación para nuevas funcionalidades

Si utilizas sugerencias del agente en tu dashboard, este flujo de trabajo replica ese comportamiento.Añade este flujo de trabajo, con las modificaciones que necesites para tu proyecto, para redactar automáticamente la documentación a medida que añades nuevas funcionalidades a tu producto.
Trigger: On push to your-org/your-product (main branch) Context repos: your-org/your-docs

Auditoría de estilo

Trigger: On push to your-org/your-docs (main branch)

Actualizar la referencia de la API

Trigger: On push to your-org/your-product (main branch) Context repos: your-org/your-docs

Hacer seguimiento del desfase de traducción

Trigger: Cron schedule 0 9 * * 3 (miércoles a las 9:00 AM UTC) Actualiza los subdirectorios de idioma de ejemplo (es/, fr/, zh/) a tus subdirectorios de idioma reales.

Auditoría de SEO y metadata

Trigger: Cron schedule 0 9 * * 1 (lunes a las 9:00 AM UTC)

Registro de cambios con notificaciones

Trigger: Cron schedule 0 9 * * 1 (lunes a las 9:00 AM UTC) Context repos: your-org/your-product Slack notifications: canal documentation, usuario tech-writer