Configurar automerge para aplicaciones GitHub

Configura flujos de trabajo de GitHub para fusionar automáticamente pull requests de Mintlify añadiendo el bot de Mintlify a la lista de exclusión de reglas de tu repositorio.

Agrega la aplicación GitHub de Mintlify a la lista de bypass de un ruleset para que la aplicación pueda crear y fusionar pull requests sin que los requisitos de revisión y verificaciones de estado la bloqueen. Esto te permite configurar flujos de trabajo para fusionar automáticamente los cambios a main.

La aplicación GitHub de Mintlify debe tener permisos de bypass en todos los rulesets que apunten a tu rama de implementación, incluyendo los rulesets definidos a nivel de organización y a nivel de repositorio. Si algún ruleset no tiene la entrada de bypass, el flujo de trabajo crea un PR, pero no lo fusiona.

​

Requisitos previos

• Acceso de administrador al repositorio (y acceso de administrador a la organización si hay rulesets a nivel de organización)
• Aplicación GitHub de Mintlify instalada en el repositorio
• Squash merging habilitado en el repositorio (Settings -> General -> Pull Requests -> Allow squash merging)
• Uno o más rulesets que apunten a la rama main (a nivel de organización o de repositorio)

​

Pasos

Repite estos pasos para cada ruleset que se aplique a tu rama de implementación. Tanto los rulesets a nivel de organización como a nivel de repositorio.

1. Navega a los rulesets

   • Rulesets del repositorio: En GitHub, ve a Settings -> Rules -> Rulesets de tu repositorio.
   • Rulesets de la organización: Ve a Settings -> Rules -> Rulesets de tu organización.
2. Selecciona el ruleset

   Haz clic en un ruleset que apunte a tu rama de implementación, que normalmente es main.

3. Agrega la aplicación GitHub de Mintlify a la lista de bypass

   1. En Bypass list, haz clic en Add bypass.
   2. Busca y selecciona la aplicación GitHub de Mintlify.
   3. Configura el modo de bypass como Always.
4. Guardar

   Haz clic en Save changes.

5. Repite para los rulesets restantes

   Si tienes rulesets adicionales a nivel de organización o de repositorio que apunten a tu rama de implementación, repite los pasos 2 a 4 para cada uno.

​

Verifica la configuración

1. Para colaboradores: Abre un PR que apunte a main. Confirma que aún requiere aprobación y verificaciones de estado exitosas antes de que puedas fusionar.
2. Para flujos de trabajo: Activa un flujo de trabajo con automerge habilitado. Confirma que el flujo de trabajo se ejecuta y fusiona exitosamente un PR.

​

Solución de problemas de automerge

Si tu configuración de automerge está incompleta, la página Workflows de tu panel muestra un aviso encima de la lista de flujos de trabajo con un enlace a los ajustes de GitHub que debes actualizar. El aviso aparece por cualquiera de los siguientes motivos:

• Squash merging está deshabilitado: Habilita Allow squash merging en los ajustes de pull requests de tu repositorio para que Mintlify pueda fusionar los PRs de los flujos de trabajo con automerge.
• Las reglas de rama necesitan un bypass para Mintlify: Agrega la aplicación GitHub de Mintlify a la lista de bypass de cada ruleset que apunte a tu rama de implementación, siguiendo los pasos anteriores.
• Una ejecución anterior de automerge no se pudo aceptar: Revisa la última ejecución fallida, corrige la configuración de GitHub correspondiente y vuelve a ejecutar el flujo de trabajo.

Haz clic en Set up on GitHub en el aviso para ir directamente a la página de ajustes correspondiente. Puedes descartar el aviso una vez que hayas resuelto el problema.