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.
-
Dans GitHub.com, accédez à la page principale du dépôt.
-
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é.
-
À gauche du nom de branche, cliquez sur .
-
Si vous le souhaitez, pour filtrer les résultats, cliquez sur les onglets ou utilisez la barre de recherche « Rechercher des branches ».
-
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.
-
Dans GitHub.com, accédez à la page principale du dépôt.
-
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.
-
Dans la barre latérale gauche, sous « Code et automatisation », cliquez sur Règles, puis sur Ensembles de règles.
-
Dans la page « Ensembles de règles », cliquez sur le nom de l’ensemble de règles que vous souhaitez modifier.
-
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 ».
-
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 ».
-
Dans GitHub.com, accédez à la page principale du dépôt.
-
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.
-
Dans la barre latérale gauche, sous « Code et automatisation », cliquez sur Règles, puis sur Ensembles de règles.
-
Cliquez sur le nom de l’ensemble de règles que vous voulez supprimer.
-
À droite du nom de l’ensemble de règles, sélectionnez , puis cliquez sur Supprimer l’ensemble de règles.
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é.
-
Dans GitHub.com, accédez à la page principale du dépôt.
-
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.
-
Dans la barre latérale gauche, sous « Code et automatisation », cliquez sur Règles, puis sur Ensembles de règles.
-
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 .
-
À droite de l’itération spécifique, sélectionnez , puis cliquez sur Comparer les modifications, Restaurer ou Télécharger.
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.
-
Dans GitHub.com, accédez à la page principale du dépôt.
-
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.
-
Dans la barre latérale gauche, sous « Code et automatisation », cliquez sur Règles, puis sur Ensembles de règles.
-
Sélectionnez la liste déroulante Nouvel ensemble de règles, puis cliquez sur Importer un ensemble de règles.
-
Ouvrez le fichier JSON exporté.
-
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.
-
Dans GitHub.com, accédez à la page principale du dépôt.
-
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.
-
Dans la barre latérale gauche, sous « Code et automatisation », cliquez sur Règles, puis sur Informations.
-
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.
-
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.
-
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.
Gérer les demandes de contournement des règles de poussée
Note
Le contournement délégué pour les règles de push est actuellement en version bêta et sujette à modification.
Vous pouvez consulter et gérer toutes les demandes de privilèges de contournement sur la page "Demandes de contournement", située dans l’ensemble de règles du référentiel.
-
Dans GitHub.com, accédez à la page principale du dépôt.
-
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.
-
Cliquez sur Demandes de contournement.
Vous pouvez filtrer les demandes par approbateur (membre de la liste de contournement), demandeur (contributeur en effectuant la demande), délai et état. Les états suivants sont attribués à une demande :
Statut | Description |
---|---|
Cancelled | La demande a été annulée par le contributeur. |
Completed | La demande a été approuvée et les commits ont été envoyées au référentiel. |
Denied | La demande a été examinée et refusée. |
Expired | La demande a expiré. Les demandes sont valides pendant 7 jours. |
Open | La demande n’a pas encore été examinée, ou a été approuvée, mais le(s) commits n’a(ont) pas été envoyés dans le référentiel. |
Lorsqu'un contributeur demande des privilèges de contournement pour publier un commit contenant un contenu restreint, les membres de la liste de contournement reçoivent tous une notification par courrier électronique contenant un lien vers la demande. Les membres de la liste de contournement disposent alors de sept jours pour examiner la demande et l’approuver ou la refuser avant qu’elle n’expire.
Le contributeur est notifié de la décision par e-mail et doit prendre les mesures requises. Si la demande est approuvée, le contributeur peut envoyer (push) le commit contenant le contenu restreint dans le référentiel. Si la demande est refusée, le contributeur doit supprimer le contenu restreint du commit pour que ce dernier puisse être envoyé dans le référentiel.