Configurar automerge para aplicaciones GitHub

Configura la fusión automática de PR de Mintlify habilitando squash merge y permitiendo que la aplicación GitHub de Mintlify omita las reglas de rama.

Configura tu repositorio para que la aplicación GitHub de Mintlify 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 que fusionen automáticamente los cambios a main.

Automerge requiere dos cosas en tu repositorio:

1. Squash merge está habilitado. Mintlify usa squash merge para integrar los PR.
2. La aplicación GitHub de Mintlify puede hacer bypass de las reglas de rama. Agrega la aplicación a la lista de bypass de cada ruleset o regla de protección de rama clásica que requiera revisiones en tu rama de implementación.

El panel muestra un banner de configuración de automerge en la página de Workflows si falta alguno de estos requisitos. Usa los enlaces del banner para ir directamente a la configuración de GitHub que necesitas actualizar.

La aplicación GitHub de Mintlify debe tener permisos de bypass en todos los rulesets y reglas de protección de rama que apunten a tu rama de implementación, incluyendo los definidos a nivel de organización y a nivel de repositorio. Si alguna regla 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 merge habilitado en el repositorio
• Uno o más rulesets o reglas de protección de rama que apunten a la rama main (a nivel de organización o de repositorio)

​

Habilitar squash merge

1. En GitHub, ve a Settings -> General de tu repositorio.
2. En Pull Requests, selecciona Allow squash merging.
3. Haz clic en Save.

Si squash merge está deshabilitado, automerge no puede completar una fusión incluso cuando todos los bypass de reglas de rama estén configurados correctamente.

​

Agregar la aplicación GitHub de Mintlify a tus reglas de rama

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.

Si tu repositorio usa reglas de protección de rama clásicas en lugar de (o además de) rulesets, abre Settings -> Branches, edita la regla que protege tu rama de implementación y agrega la aplicación GitHub de Mintlify a Allow specified actors to bypass required pull requests.

​

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.
3. En el panel: Abre la página de Workflows y confirma que el banner de configuración de automerge ya no se muestra.