Gestion des ensembles de règles d’un dépôt

Dans cet article

Vous pouvez modifier, surveiller et supprimer des ensembles de règles existants dans un dépôt pour modifier la façon dont les participants peuvent interagir avec des branches et des balises spécifiques.

Qui peut utiliser cette fonctionnalité

Toute personne disposant d’un accès en lecture à un dépôt peut voir les ensembles de règles du dépôt. Les personnes avec un accès administrateur à un dépôt, ou avec un rôle personnalisé avec l’autorisation « modifier les règles du dépôt », peuvent créer, modifier et supprimer des ensembles de règles pour un dépôt.

Les ensembles de règles sont disponibles dans les dépôts publics avec GitHub Free et GitHub Free pour les organisations, et dans les dépôts publics et privés avec GitHub Pro, GitHub Team et GitHub Enterprise Cloud. Pour plus d’informations, consultez « Plans de GitHub ».

Après avoir créé un ensemble de règles, vous pouvez apporter des modifications à l’ensemble de règles pour modifier la façon dont les participants peuvent interagir avec les branches ou balises ciblées. Par exemple, vous pouvez ajouter des règles pour mieux protéger vos branches ou balises, ou vous pouvez désactiver temporairement un ensemble de règles pour résoudre les effets inattendus sur l’expérience du collaborateur pour votre référentiel.

Vous pouvez utiliser les API REST et GraphQL pour gérer les ensembles de règles. Pour plus d’informations, consultez « Règles » et « Mutations ».

Affichage des ensembles de règles d’un dépôt

Toute personne disposant d’un accès en lecture à un dépôt peut voir les ensembles de règles ciblant le dépôt. Cela peut être utile si vous souhaitez savoir pourquoi vous ne pouvez pas commiter sur une branche. Dans la page « Ensembles de règles », vous pouvez afficher les ensembles de règles actifs ciblant une branche ou une étiquette spécifique.

  1. Dans GitHub.com, accédez à la page principale du dépôt.

  2. Dans l’arborescence de fichiers à gauche, sélectionnez le menu déroulant de branches , puis cliquez sur Afficher toutes les branches. Vous trouverez également le menu déroulant de branches en haut de l’éditeur de fichiers intégré.

    Capture d’écran de l’arborescence de fichiers d’un dépôt. Un menu déroulant pour les branches est développé et mis en évidence avec un encadré orange foncé.

  3. À gauche de la branche, cliquez sur .

    Capture d’écran d’une liste de branches dans un dépôt. À côté de la branche « main », une icône d’un bouclier avec un trou de serrure est mise en évidence avec un encadré orange.

  4. Si vous le souhaitez, pour afficher les ensembles de règles d’une autre branche ou étiquette, utilisez le menu déroulant du sélecteur de branche.

    Capture d’écran de la page « Ensembles de règles ». Au-dessus d’un ensemble de règles, un menu déroulant, illustré avec une icône de branche et le texte « team-test », est mis en évidence avec un encadré orange.

  5. Cliquez sur le nom de l’ensemble de règles que vous voulez voir.

Modification d’un ensemble de règles

Vous pouvez modifier un ensemble de règles pour en changer certaines parties, telles que le nom, les autorisations de contournement ou les règles. Vous pouvez également modifier un ensemble de règles pour changer son état, par exemple si vous souhaitez activer ou désactiver temporairement un ensemble de règles.

  1. Dans GitHub.com, accédez à la page principale du dépôt.

  2. Sous le nom de votre dépôt, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.

    Capture d’écran d’un en-tête de dépôt montrant les onglets. L’onglet « Paramètres » est mis en évidence avec un encadré orange foncé.

  3. Dans la barre latérale gauche, sous « Code et automatisation », cliquez sur Règles, puis sur Ensembles de règles.

    Capture d’écran de la barre latérale de la page « Paramètres » d’un dépôt. Le sous-menu « Règles » est développé et l’option « Ensembles de règles » est encadrée en orange.

  4. Dans la page « Ensembles de règles », cliquez sur le nom de l’ensemble de règles que vous souhaitez modifier.

  5. Modifiez l’ensemble de règles si nécessaire. Pour plus d’informations sur les règles disponibles, consultez « Règles disponibles pour les ensembles de règles ».

  6. En bas de la page, cliquez sur Save changes.

Suppression d’un ensemble de règles

Conseil : Si vous souhaitez désactiver temporairement un ensemble de règles, mais que vous ne souhaitez pas le supprimer, vous pouvez définir l’état de l’ensemble de règles sur « Désactivé ». Pour plus d’informations, consultez « Modification d’un ensemble de règles ».

  1. Dans GitHub.com, accédez à la page principale du dépôt.

  2. Sous le nom de votre dépôt, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.

    Capture d’écran d’un en-tête de dépôt montrant les onglets. L’onglet « Paramètres » est mis en évidence avec un encadré orange foncé.

  3. Dans la barre latérale gauche, sous « Code et automatisation », cliquez sur Règles, puis sur Ensembles de règles.

    Capture d’écran de la barre latérale de la page « Paramètres » d’un dépôt. Le sous-menu « Règles » est développé et l’option « Ensembles de règles » est encadrée en orange.

  4. Cliquez sur le nom de l’ensemble de règles que vous voulez supprimer.

  5. À droite du nom de l’ensemble de règles, sélectionnez , puis cliquez sur Supprimer l’ensemble de règles.

    Capture d’écran de la page de modification d’un ensemble de règles. Sous un bouton représenté par trois points, une option intitulée « Supprimer l’ensemble de règles » est encadrée en orange.