Skip to main content

Requisitos previos

También puedes crear, listar y eliminar automatizaciones desde la terminal con mint automations. La CLI es útil para scripts y CI. El dashboard es la forma más sencilla de configurar y supervisar las ejecuciones de automatizaciones.

Activar una automatización

  1. Abre la página Automatizaciones en tu dashboard.
  2. 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.
  3. Si se abre la página de configuración, completa los campos obligatorios y haz clic en Save.
Para cambiar la configuración de una automatización activa, haz clic en el botón de configuración en su tarjeta para abrir su página de configuración. Usa el interruptor en el encabezado de la página para activar o desactivar la automatización y haz clic en Save para aplicar los cambios.

Configuraciones

Activador

Cada automatización tiene un activador predeterminado que controla cuándo se ejecuta. Para cambiar el activador, selecciona otro tipo de activador en la página de configuración de la automatización.
  • 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.
  • 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). Los valores de cron se almacenan en UTC; el dashboard convierte las horas de los preajustes hacia y desde tu zona horaria local. 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 de nivel superior 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.

Modo de actualización

Cada automatización tiene un modo predeterminado para realizar actualizaciones. Puede fusionar los cambios directamente en tu repositorio de contenido o abrir una pull request para revisión. Selecciona el modo en la sección After automation runs de la página de configuración de la automatización. Selecciona Update and merge changes para fusionar los cambios automáticamente. Selecciona Modify and wait for review para requerir una revisión antes de que los cambios se publiquen.
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

Para automatizaciones personalizadas y algunas automatizaciones predefinidas, puedes añadir repositorios de contexto: repositorios de código fuente adicionales que el agente lee cuando se ejecuta la automatización. Esto es útil cuando el prompt de tu automatización hace referencia a código, APIs u otro contenido que vive fuera del repositorio de tu proyecto. Puedes añadir hasta 10 repositorios de contexto por automatización. Para cada repositorio de GitHub, instala la aplicación de GitHub de Mintlify. Añade repositorios en la página de configuración de la aplicación de GitHub.

Integraciones

Para automatizaciones personalizadas y otras automatizaciones predefinidas compatibles, puedes habilitar integraciones para que el agente obtenga contexto desde herramientas compartidas como Notion, Jira o Linear. Abre la página de configuración de la automatización y selecciona las integraciones que quieres usar en Tools. Puedes conectar una integración compartida desde el selector. Las integraciones personales solo están disponibles para su propietario al usar el agente de Slack y no pueden añadirse a automatizaciones. Si seleccionas Integración como activador, la integración que activa la automatización se añade automáticamente como herramienta. Consulta Integraciones para conocer los alcances, eventos y permisos.

Notificaciones de Slack

Envía mensajes de Slack a uno o más canales cuando se ejecuten las automatizaciones. Para activar las notificaciones de Slack:
  1. Instala la aplicación de Slack de Mintlify en tu espacio de trabajo.
  2. Haz clic en Configure Slack en la página Automatizaciones de tu dashboard.
  3. Selecciona uno o más canales a los que enviar notificaciones.
  4. Haz clic en Save changes.
Una vez activado, Mintlify publica en los canales seleccionados cuando:
  • 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.

Instrucciones

Añade instrucciones opcionales que se agregan al prompt base de la automatización en cada ejecución. Úsalas para ajustar el estilo, el tono u otros comportamientos específicos del proyecto sin cambiar la lógica principal de la automatización.

Idiomas de destino

Cuando activas la automatización Translate content, selecciona uno o más idiomas para mantenerlos sincronizados con tu contenido fuente.
  • Mintlify lee los idiomas definidos en tu docs.json para 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.
Puedes añadir idiomas de destino en cualquier momento abriendo la página de configuración de la automatización y editando el campo Translate to.

Configuración de GitLab

Para usar repositorios de GitLab en una automatización, conecta cada proyecto a través de la página de configuración de OAuth de GitLab. Conecta cada repositorio que la automatización utilice: tu repositorio de documentación y cualquier repositorio de activación o contexto. Debes tener al menos el rol de Maintainer en cada proyecto.
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

  1. Ve a la página Automatizaciones en tu dashboard.
  2. Haz clic en el interruptor junto a una automatización para desactivarla.
Cuando vuelves a activar una automatización programada o cambias su programación, Mintlify recalcula el próximo tiempo de ejecución a partir de la hora actual. Las automatizaciones desactivadas no conservan un tiempo de ejecución pendiente.

Eliminar una automatización

Puedes eliminar automatizaciones personalizadas desde el dashboard. Las automatizaciones predefinidas no se pueden eliminar desde el dashboard. Desactívalas en su lugar o usa la CLI para eliminarlas.
  1. Abre la página Automatizaciones en tu dashboard.
  2. 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.
  3. Haz clic en Delete automation en la parte inferior de la página y confirma.
Para eliminar cualquier automatización desde la terminal, usa mint automations. La eliminación es permanente y no se puede deshacer.

Ejecutar una automatización manualmente

Puedes activar una automatización bajo demanda sin esperar a su próxima ejecución programada o basada en eventos.
  1. Abre la página Automatizaciones en tu dashboard.
  2. Haz clic en el botón de configuración en la tarjeta de la automatización para abrir su página de configuración.
  3. Haz clic en el botón de ejecución (Test run o Run now, según la automatización).
  4. 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 y usa bastantes más créditos que una ejecución dirigida.
    • Specific pull request: Limita la ejecución a una sola pull request en un repositorio seleccionado.
  5. Haz clic en Run now.
Las ejecuciones manuales guardan la configuración actual de la automatización y activan la automatización antes de comenzar. Cuentan para tu uso de créditos y aparecen en el historial de ejecuciones junto a las ejecuciones activadas automáticamente. Puedes ejecutar manualmente automatizaciones con activadores de programación, actualización de contenido o cambio de código. Las automatizaciones activadas por integración solo se ejecutan cuando ocurre su evento configurado, por lo que su botón de ejecución no está disponible. La automatización Translate content siempre puede ejecutarse manualmente.

Activar una automatización programada mediante la API

Para automatizaciones con un activador de Programación personalizada, puedes iniciar una ejecución desde tus propias herramientas en lugar de esperar a la próxima hora programada. Usa el endpoint Trigger automation para iniciar una ejecución desde un pipeline CI/CD, un script de versión o cualquier servicio que pueda hacer una solicitud HTTP autenticada. Las ejecuciones activadas por API se comportan exactamente igual que las ejecuciones programadas: recogen todo lo que ha cambiado desde la última ejecución completada, cuentan para el uso de créditos y aparecen en el historial de ejecuciones.

Ver el historial de ejecuciones

La pestaña Runs de la página de automatizaciones muestra una lista de todas las ejecuciones de todas las automatizaciones. Una ejecución corresponde a una única puesta en marcha de una automatización. Una ejecución puede crear una nueva pull request, actualizar una pull request existente, fallar o no encontrar nada que cambiar.
  1. Abre la página Automatizaciones en tu dashboard.
  2. Usa los menús desplegables para filtrar por automatizaciones o estado específicos.
Cada resultado muestra uno de los siguientes estados:
  • 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.
Puedes actuar sobre los resultados directamente desde la lista. Para las ejecuciones pendientes de revisión, haz clic en Accept para fusionar los cambios o en Preview para ver los cambios en el editor. Para los resultados fallidos, haz clic en Re-trigger para iniciar la ejecución de nuevo. Para ver el prompt de una ejecución, los archivos que leyó o modificó y cualquier pull request, haz clic en el menú de acciones de la ejecución y luego haz clic en View run details.

Continuar una ejecución en el editor

Después de que una automatización se complete y cree cambios en una rama, puedes abrir esos cambios directamente en el editor para revisarlos, refinarlos o publicarlos.
  1. Abre la página Automatizaciones en tu dashboard.
  2. En la pestaña Runs, haz clic en Preview en la ejecución con la que quieres seguir trabajando en el editor.
El editor se abre en la rama de la automatización con el panel del agente ya desplegado. El panel del agente muestra cada página que la automatización modificó. Haz clic en cualquier página para ver los cambios realizados por la automatización. El agente del editor tiene contexto completo sobre lo que hizo la automatización, incluido su prompt, un resumen de los cambios y qué páginas modificó la automatización. Pídele al agente que refine o amplíe el trabajo sin tener que volver a explicar el contexto.