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 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 et voir les informations des ensembles de règles. Pour plus d’informations, consultez « À propos des rôles de référentiel personnalisés ».

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 Enterprise Cloud dans les référentiels internes et privés, les fourches de référentiels dont les ensembles de règles de poussée sont activés, et les organisations de votre entreprise.

Dans cet article

Après avoir créé un ensemble de règles, vous pouvez y apporter des modifications. Par exemple, vous pouvez ajouter des règles pour mieux protéger vos branches ou balises, ou vous pouvez basculer votre ensemble de règles du mode « Évaluer » en mode « Actif » après avoir testé ses effets sur l’expérience du collaborateur pour votre dépôt.

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 ».

Conseil : Si vous êtes propriétaire d’une organisation, vous pouvez créer des ensembles de règles au niveau de l’organisation. Vous pouvez appliquer ces ensembles de règles à des dépôts spécifiques de votre organisation et à des branches spécifiques dans ces dépôts. Pour plus d’informations, consultez « Création des ensembles de règles pour les référentiels de votre organisation ».

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 de poussée. Vous verrez également les ensembles de règles s’exécutant en mode « Évaluer », qui ne sont pas appliqués.

Pour les jeux de règles de poussées pour les référentiels fourchés, la page "Ensemble de règles" indiquera que l'ensemble de règles est géré par le référentiel source dans lequel la règle est appliquée.

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

  4. Si vous le souhaitez, pour filtrer les résultats, cliquez sur les onglets ou utilisez la barre de recherche « Rechercher des branches ».

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

Modification d’un ensemble de règles

Remarque : Si un ensemble de règles a été créé au niveau de l’organisation, vous ne pouvez pas le modifier à partir des paramètres du dépôt. Si vous êtes autorisé à modifier l’ensemble de règles, vous pouvez le faire dans les paramètres de votre organisation. Pour plus d’informations, consultez « Gestion des ensembles de règles pour les dépôts de votre organisation ».

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.

Utilisation de l’historique de l’ensemble de règles

Remarques :

  • L’historique de l’ensemble de règles est actuellement en version bêta publique et susceptible d’être modifié.
  • Seules les modifications apportées à un ensemble de règles après la version bêta publique, le 11 octobre 2023, sont incluses dans l’historique de l’ensemble de règles.

Vous pouvez afficher toutes les modifications apportées à un ensemble de règles et revenir à une itération spécifique. Vous pouvez également télécharger un fichier JSON contenant la configuration de l’ensemble de règles à une itération spécifique. La liste de contournement d’un ensemble de règles est exclue du fichier JSON exporté.

  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. Pour afficher l’historique des modifications de l’ensemble de règles, sélectionnez à droite du nom de l’ensemble de règles, puis cliquez sur Historique .

    Capture d’écran de la page des ensembles de règles d’un référentiel. Sous un bouton représenté par trois points, une option intitulée « Historique » est surlignée en orange.

  5. À droite de l’itération spécifique, sélectionnez , puis cliquez sur Comparer les modifications, Restaurer ou Télécharger.

    Capture d’écran de la page de l’historique des ensembles de règles d’un référentiel. Un menu déroulant, étiqueté avec trois points, est développé et mis en évidence par un contour orange.

Importation d’un ensemble de règles

Vous pouvez importer un ensemble de règles à partir d’un autre référentiel ou d’une autre organisation à 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. 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. 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. Un menu déroulant intitulé « Nouvel ensemble de règles » est développé et l’option « Importer un ensemble de règles » est mise en évidence par un contour 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 réussi.
  • 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.

Capture d’écran de la page « Informations sur les règles ». Trois actions sont listées : l’une marquée « réussite », l’autre marquée « contournement » et la dernière marquée « échec » avec une étiquette « évaluation ».

  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 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é « octocat created not-allowed », une icône de trois points horizontaux est encadrée en orange.

  6. Vous pouvez également passer en revue les détails de la file d’attente de fusion pour les demandes de tirage (pull request) correspondantes dans le même groupe de fusion.

    Remarque : la règle de file d’attente de fusion est en version bêta publique et cette interface est soumise à modification.