Règles de fusion

Définissez les exigences à respecter avant que les demandes de changement puissent être fusionnées

Les règles de fusion vous permettent de définir des exigences qui doivent être remplies avant que les demandes de modification puissent être fusionnées, comme nécessiter une relecture par un utilisateur spécifique ou exiger un sujet ou une description pour la demande de modification.

Ces règles aident à maintenir la qualité du contenu et à garantir des processus de relecture appropriés dans votre flux de travail de documentation.

Lorsque vous avez configuré des règles de fusion, elles évalueront automatiquement les demandes de modification avant qu'elles ne puissent être fusionnées. Si une règle n'est pas satisfaite, la fusion sera bloquée jusqu'à ce que les exigences soient remplies.

Cela fournit un moyen automatisé de faire respecter les normes de collaboration et de relecture de votre équipe.

Utilisation des règles de fusion

Vous pouvez configurer des règles de fusion à différents niveaux pour correspondre au flux de travail de votre équipe :

Configuration au niveau de l'organisation

Les organisations peuvent définir des règles de fusion par défaut que tous les espaces héritent. Cela assure la cohérence entre plusieurs espaces tout en permettant aux espaces individuels de personnaliser leurs règles selon les besoins.

Pour configurer les règles de fusion de votre organisation, ouvrez le menu de l'organisation en haut de la barre latérale et choisissez Paramètres . Dans l'écran Paramètres, sélectionnez Règles de fusion sous la Organisation section de la barre latérale. Ici, vous pouvez spécifier les règles de fusion pour l'ensemble de votre organisation.

Choisissez entre fusion sans restriction, ou sélectionnez parmi la liste des préréglages à appliquer aux demandes de modification sur l'ensemble de votre organisation.

Configuration au niveau de l'espace

Que vous ayez activé ou non des règles de fusion pour toute l'organisation, chaque espace peut avoir ses propres exigences de fusion adaptées à son contenu et à la structure de son équipe.

Cela vous donne la flexibilité d'avoir des règles plus strictes pour la documentation importante et des règles plus souples pour le contenu de brouillon.

Lors de la configuration des règles de fusion pour un espace, vous pouvez choisir de :

• Hériter des règles de fusion de votre organisation

• Définir des règles personnalisées spécifiques à cet espace

• Désactiver les règles de fusion entièrement

Si vous héritez des règles de l'organisation, toute modification des règles de fusion de l'organisation s'appliquera automatiquement à l'espace.

Pour configurer les règles de fusion pour votre organisation, ouvrez le menu Actions en haut à gauche de l'éditeur, puis sélectionnez Règles de fusion. Ici, vous pouvez spécifier si vous souhaitez hériter des règles de fusion de votre organisation ou en configurer de nouvelles spécifiques à cet espace.

Évaluation des règles

Comment fonctionnent les règles

Lorsqu'une personne souhaite fusionner une demande de modification, GitBook évaluera toutes les règles configurées dans l'ordre :

• Toutes les règles d'une configuration doivent être satisfaites pour qu'une fusion soit autorisée

• Les règles sont évaluées dans l'ordre dans lequel elles apparaissent dans votre configuration

• Si une règle échoue, la fusion est bloquée avec un message d'erreur approprié

• Les règles avec capacités de contournement peuvent annuler des échecs précédents

Règles de contournement

Certaines règles ont des capacités de contournement (comme Autoriser des acteurs spécifiés à contourner les exigences). Ces règles spéciales peuvent annuler d'autres échecs de règles. Si une règle de contournement s'évalue à vrai, la fusion sera autorisée même si d'autres règles ont échoué.

Bonnes pratiques

Lors de la configuration des règles de fusion, prenez en compte ces recommandations :

• Commencez simple: Commencez par des règles basiques comme exiger au moins une relecture.

• Montez en charge progressivement: Ajoutez des exigences plus spécifiques à mesure que votre équipe grandit et que les flux de travail mûrissent.

• Utilisez le contournement avec précaution: N'accordez des permissions de contournement qu'aux administrateurs de confiance.

• Revoyez régulièrement: Ajustez les règles en fonction des modèles de flux de travail réels de votre équipe.

• Testez d'abord: Dans la mesure du possible, testez les modifications de règles dans un espace de test avant de les appliquer aux espaces de production.

Types de règles disponibles

Exigences de relecture

Règle	Description
Exiger au moins une relecture	Garantit qu'au moins un membre de l'équipe a relu la demande de modification avant qu'elle puisse être fusionnée.
Exiger que toutes les relectures soient approuvées	Toutes relectures terminées (non demandées) doivent être des approbations. Si un relecteur a demandé des modifications ou a rejeté la demande de modification, la fusion sera bloquée.
Exiger une relecture par des acteurs spécifiés	Exige l'approbation de tous les utilisateurs spécifiés. Vous pouvez sélectionner des membres spécifiques de l'équipe qui doivent relire et approuver la demande de modification avant qu'elle puisse être fusionnée.
Exiger une relecture par l'un des acteurs spécifiés	Exige l'approbation d'au moins un des utilisateurs spécifiés. Cela est utile lorsque vous avez plusieurs relecteurs qualifiés mais que vous n'avez besoin que d'une seule approbation du groupe.
Exiger une relecture par l'agent Docs (bientôt disponible)	Exige une relecture de l'agent GitBook IA. Cela garantit que des vérifications automatisées de qualité sont effectuées sur les modifications de contenu avant la fusion.

Exigences pour les demandes de modification

Règle	Description
Exiger que la demande de modification soit à jour	La demande de modification doit être à jour avec la branche principale du contenu. Si le contenu principal a été mis à jour depuis la création de la demande de modification, vous devrez la rebaser ou la mettre à jour avant de fusionner.
Exiger un sujet	La demande de modification doit avoir un sujet/titre descriptif. Les sujets vides bloqueront la fusion.
Exiger une description	La demande de modification doit inclure une description expliquant quelles modifications ont été apportées et pourquoi.

Options avancées

Règle	Description
Autoriser des acteurs spécifiés à contourner les exigences	Vous pouvez désigner des utilisateurs spécifiques autorisés à contourner toutes les autres exigences des règles de fusion. Cela est utile pour les administrateurs ou les situations d'urgence où les règles doivent être contournées.
Expression personnalisée	Vous pouvez créer des règles de fusion avancées en utilisant des expressions JavaScript personnalisées. Cela vous permet de définir une logique complexe basée sur le contexte d'évaluation, avec accès aux propriétés de la demande de modification, des relectures et de l'utilisateur tentant de fusionner.

Expressions personnalisées

Lorsque vous créez une expression personnalisée, elle sera évaluée chaque fois que quelqu'un tente de fusionner une demande de modification. Si l'expression renvoie true, la fusion est autorisée. Si elle renvoie false, la fusion est bloquée.

Les expressions personnalisées prennent en charge la syntaxe JavaScript standard (ES2022) et ont une longueur maximale de 1024 caractères.

Variables de contexte disponibles :

• changeRequest.subject - Le sujet/titre de la demande de modification

• changeRequest.description - La description de la demande de modification

• changeRequest.outdated - Indique si la demande de modification est obsolète (booléen)

• changeRequest.createdBy.id - ID de l'utilisateur qui a créé la demande de modification

• reviews - Tableau d'objets de relecture, chacun contenant :

  • reviews[].status - Statut de la relecture ("approved" ou "changes_requested")

  • reviews[].reviewer.id - ID du relecteur

• actor.id - ID de l'utilisateur tentant de fusionner

Exemples d'expressions courantes :

Exiger plusieurs relectures approuvées

reviews.filter(r => r.status === "approved").length >= 2

Exiger l'approbation d'un utilisateur spécifique

reviews.some(r => r.reviewer.id === "harry" && r.status === "approved")

Exiger une description pour les modifications urgentes

!changeRequest.subject.includes("[URGENT]") || !!changeRequest.description

Autoriser l'auto-fusion uniquement pour les modifications mineures

changeRequest.createdBy.id === actor.id ? changeRequest.subject.startsWith("[minor]") : true