Configurer l'automerge pour les applications GitHub

Configurez la fusion automatique des PR Mintlify en activant le squash merge et en autorisant l’application GitHub Mintlify à contourner les règles.

Configurez votre dépôt afin que l’application GitHub Mintlify 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 qui fusionnent automatiquement les modifications dans main.

L’automerge nécessite deux conditions sur votre dépôt :

1. La fusion par écrasement (squash merge) est activée. Mintlify utilise le squash merge pour intégrer les PR.
2. L’application GitHub Mintlify peut contourner les règles de branche. Ajoutez l’application à la liste de contournement pour chaque ensemble de règles ou règle de protection de branche classique qui exige des révisions sur votre branche de déploiement.

Le tableau de bord affiche une bannière de configuration de l’automerge sur votre page Workflows si l’une de ces exigences est manquante. Utilisez les liens de la bannière pour accéder directement aux paramètres GitHub à mettre à jour.

L’application GitHub Mintlify doit disposer de permissions de contournement sur tous les ensembles de règles et règles de protection de branche ciblant votre branche de déploiement, y compris ceux définis au niveau de l’organisation et au niveau du dépôt. Si une règle 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
• Fusion par écrasement (squash merge) activée sur le dépôt
• Un ou plusieurs ensembles de règles ou règles de protection de branche ciblant la branche main (au niveau de l’organisation ou du dépôt)

​

Activer la fusion par écrasement

1. Sur GitHub, allez dans Settings -> General de votre dépôt.
2. Sous Pull Requests, sélectionnez Allow squash merging.
3. Cliquez sur Save.

Si la fusion par écrasement est désactivée, l’automerge ne peut pas finaliser une fusion, même si tous les contournements de règles de branche sont correctement configurés.

​

Ajouter l’application GitHub Mintlify à vos règles de branche

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.

Si votre dépôt utilise des règles de protection de branche classiques au lieu de (ou en plus de) ensembles de règles, ouvrez Settings -> Branches, modifiez la règle qui protège votre branche de déploiement, puis ajoutez l’application GitHub Mintlify à Allow specified actors to bypass required pull requests.

​

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.
3. Dans le tableau de bord : Ouvrez la page Workflows et confirmez que la bannière de configuration de l’automerge ne s’affiche plus.