Configurer l'automerge pour les applications GitHub

Configurez des workflows GitHub pour fusionner automatiquement les pull requests Mintlify en ajoutant le bot Mintlify à la liste de contournement du ruleset de votre dépôt.

Ajoutez l’application GitHub Mintlify à la liste de contournement d’un ensemble de règles pour que l’application puisse créer et fusionner des pull requests sans que les exigences de révision et de vérification de statut ne la bloquent. Cela vous permet de configurer des workflows pour fusionner automatiquement les modifications dans main.

L’application GitHub Mintlify doit disposer de permissions de contournement sur tous les ensembles de règles ciblant votre branche de déploiement, y compris les ensembles de règles définis au niveau de l’organisation et au niveau du dépôt. Si un ensemble de règles ne contient pas l’entrée de contournement, le workflow crée une PR, mais ne la fusionne pas.

​

Prérequis

• Accès administrateur au dépôt (et accès administrateur à l’organisation s’il existe des ensembles de règles au niveau de l’organisation)
• Application GitHub Mintlify installée sur le dépôt
• Un ou plusieurs ensembles de règles ciblant la branche main (au niveau de l’organisation ou du dépôt)

​

Étapes

Répétez ces étapes pour chaque ensemble de règles qui s’applique à votre branche de déploiement. Tant les ensembles de règles au niveau de l’organisation que au niveau du dépôt.

1. Accédez aux ensembles de règles

   • Ensembles de règles du dépôt : Sur GitHub, allez dans Settings -> Rules -> Rulesets de votre dépôt.
   • Ensembles de règles de l’organisation : Allez dans Settings -> Rules -> Rulesets de votre organisation.
2. Sélectionnez l'ensemble de règles

   Cliquez sur un ensemble de règles qui cible votre branche de déploiement, généralement main.

3. Ajoutez l'application GitHub Mintlify à la liste de contournement

   1. Sous Bypass list, cliquez sur Add bypass.
   2. Recherchez et sélectionnez l’application GitHub Mintlify.
   3. Définissez le mode de contournement sur Always.
4. Enregistrer

   Cliquez sur Save changes.

5. Répétez pour les ensembles de règles restants

   Si vous avez des ensembles de règles supplémentaires au niveau de l’organisation ou du dépôt qui ciblent votre branche de déploiement, répétez les étapes 2 à 4 pour chacun d’entre eux.

​

Vérifiez la configuration

1. Pour les contributeurs : Ouvrez une PR ciblant main. Confirmez qu’elle nécessite toujours une approbation et des vérifications de statut réussies avant de pouvoir fusionner.
2. Pour les workflows : Déclenchez un workflow avec l’automerge activé. Confirmez que le workflow s’exécute et fusionne avec succès une PR.