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

Vous pouvez modifier, surveiller et supprimer des ensembles de règles existants dans un dépôt afin de modifier la manière dont les utilisateurs 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 disposant d’un accès administrateur à un référentiel, ou d’un rôle personnalisé avec l’autorisation « modifier les règles du référentiel », peuvent créer, modifier et supprimer des ensembles de règles pour un référentiel.

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.

Les ensembles de règles de poussée sont disponibles pour le plan GitHub Team dans les référentiels internes et privés, et les fourches de référentiels dont les ensembles de règles de poussée sont activés.

Dans cet article

Après avoir créé un ensemble de règles, vous pouvez toujours y apporter des modifications. Par exemple, vous pouvez ajouter des règles pour mieux protéger vos branches ou étiquettes, ou basculer temporairement désactiver un ensemble de règles pour résoudre les effets inattendus de l’expérience de contributeur 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 « Points de terminaison d’API REST pour les règles » et « Mutations ».

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

Dans la page « Ensembles de règles », toute personne disposant d’un accès en lecture au référentiel peut afficher les ensembles de règles actifs ciblant une certaine branche, balise ou restriction Push.

Pour les ensembles de règles de push dans les dépôts dupliqués, la page « Ensemble de règles » indiquera que l’ensemble de règles est géré par le dépôt source dans lequel la règle est appliquée.

  1. Sur GitHub, accédez à la page principale du référentiel.

  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 du nom de la branche, cliquez sur .

    Conseil

    Seules les branches qui ont un ensemble de règles ont une icône adjacente à leur nom.

  4. Si vous le souhaitez, vous pouvez filtrer les résultats en cliquant sur les onglets ou en utilisant la barre de recherche « Rechercher des branches ».

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

Vous pouvez également afficher les ensembles de règles actifs :

  • En ajoutant le slug /rules à l’URL du dépôt. Par exemple, pour afficher les règles du référentiel de documentation open source à GitHub, vous accédez à https://github.com/github/docs/rules.

  • Dans la zone de fusion si des règles bloquent la fusion d’une demande de tirage.

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. Sur GitHub, accédez à la page principale du référentiel.

  2. Sous le nom de votre référentiel, 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. Sur GitHub, accédez à la page principale du référentiel.

  2. Sous le nom de votre référentiel, 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 du jeu de règles, sélectionnez , puis cliquez sur Supprimer un jeu 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.

Importation d’un ensemble de règles

Vous pouvez importer un ensemble de règles existant à l’aide d’un fichier JSON. Ceci peut être utile si vous souhaitez appliquer le même ensemble de règles à plusieurs référentiels ou organisations.

  1. Sur GitHub, accédez à la page principale du référentiel.

  2. Sous le nom de votre référentiel, 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. Sélectionnez la liste déroulante Nouvel ensemble de règles, puis cliquez sur Importer un ensemble de règles.

    Capture d’écran de la page des ensembles de règles d’un référentiel. Le menu déroulant « Nouvel ensemble de règles » est développé et l’option « Importer un ensemble de règles » est mise en évidence en orange.

  5. Ouvrez le fichier JSON exporté.

  6. Passez en revue l’ensemble de règles importé, puis cliquez sur Créer.

Affichage des informations sur les ensembles de règles

Vous pouvez afficher des informations sur les ensembles de règles pour voir comment les ensembles de règles affectent un dépôt. Dans la page « Informations sur les règles », vous verrez une chronologie des actions utilisateur suivantes. Vous pouvez utiliser des filtres pour trouver ce que vous recherchez.

  • Les actions qui ont été vérifiées par rapport à un ou plusieurs ensembles de règles et qui ont été approuvées.
  • Les actions qui ont été vérifiées par rapport à un ou plusieurs ensembles de règles et qui ont échoué.
  • Les actions pour lesquelles une personne a contourné un ou plusieurs ensembles de règles.

Si un ensemble de règles s’exécute en mode « Évaluer », vous pouvez voir les actions qui auraient réussi ou échoué si l’ensemble de règles avait été actif.

En outre, ces insights sont disponibles via l’API REST des suites de règles.

Capture d’écran de la page « Informations sur les règles ». Trois actions sont répertoriées : « Réussite », « Contournement » et « Échec ». L’action ayant échoué est marquée d’une étiquette « évaluation ».

  1. Sur GitHub, accédez à la page principale du référentiel.

  2. Sous le nom de votre référentiel, 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 Informations.

    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 « Informations » est encadrée en orange.

  4. Dans la page « Informations sur les règles », utilisez les menus déroulants en haut de la page pour filtrer les actions par ensemble de règles, branche, acteur et période.

  5. Pour voir quelles règles spécifiques ont échoué ou ont nécessité un contournement, cliquez sur , puis développez le nom de l’ensemble de règles.

    Capture d’écran de la page « Informations sur les règles ». À droite d’un événement intitulé « not-allowed », une icône de trois points horizontaux est mise en évidence en orange.

Tableau de bord Aperçus des règles

Remarque

Le tableau de bord des insights sur les règles est dans préversion publique et sujet à modification. Il est disponible pour les plans GitHub Team et GitHub Enterprise Cloud.

Le tableau de bord Insights des règles vous donne un résumé visuel et général de l’activité d’évaluation des règles pour votre référentiel, notamment :

  •         **Réussites, échecs et contournements au fil du temps** : graphique montrant les tendances dans les résultats d’évaluation des règles, ce qui vous aide à repérer les pics dans les push bloqués ou les modèles inhabituels.

  •         **Principaux utilisateurs contournants** : une liste des utilisateurs les plus actifs pour vos ensembles de règles.

Chaque graphique revient à la page Insights des règles avec des filtres préremplis, ce qui vous permet d’explorer rapidement des états, des contournements ou des intervalles de temps spécifiques.

Pour afficher le tableau de bord :

  1. Sur GitHub, accédez à la page principale du référentiel.

  2. Sous le nom de votre référentiel, 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 Informations.

  4. En haut de la page « Informations sur les règles », affichez les graphiques de tableau de bord pour obtenir une vue d’ensemble de l’activité d’évaluation des règles.