Gestion des environnements pour le déploiement

Prérequis

Pour obtenir des informations générales sur les environnements, consultez Déploiement avec GitHub Actions.
Pour plus d’informations sur les règles disponibles, consultez Déploiements et environnements.

Création d’un environnement

Pour configurer un environnement dans un référentiel de comptes personnels, vous devez être le propriétaire du référentiel. Pour configurer un environnement dans un référentiel d’organisation, vous devez disposer d’un accès admin.

Sur GitHub, accédez à la page principale du référentiel.
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, cliquez sur Environnements.
Cliquez sur Nouvel environnement.
Entrez un nom pour l’environnement, puis cliquez sur Configurer l’environnement. Les noms d’environnements ne respectent pas la casse. Un nom d’environnement ne peut pas dépasser 255 caractères et doit être unique dans le dépôt.
Si vous le souhaitez, spécifiez des personnes ou des équipes qui doivent approuver les travaux de workflow qui utilisent cet environnement. Pour plus d’informations, consultez « Déploiements et environnements ».
1. Sélectionnez Required reviewers.
2. Entrez jusqu’à 6 personnes ou équipes. Seul l’un des réviseurs requis doit approuver le travail pour qu’il continue.
3. Si vous le souhaitez, pour empêcher les utilisateurs d’approuver les exécutions de flux de travail qu’ils ont déclenchées, sélectionnez Empêcher l’auto-révision.
4. Cliquez sur Enregistrer les règles de protection.
Si vous le souhaitez, spécifiez le temps d’attente avant d’autoriser les travaux de workflow qui utilisent cet environnement à poursuivre. Pour plus d’informations, consultez « Déploiements et environnements ».
1. Sélectionnez Minuteur d’attente.
2. Entrez le nombre de minutes à attendre.
3. Cliquez sur Enregistrer les règles de protection.
Si vous le souhaitez, interdisez le contournement des règles de protection configurées. Pour plus d’informations, consultez « Déploiements et environnements ».
1. Désélectionnez Autoriser les administrateurs à contourner les règles de protection configurées.
2. Cliquez sur Enregistrer les règles de protection.
Si vous le souhaitez, activez toutes les règles de protection de déploiement personnalisées qui ont été créées avec GitHub Apps. Pour plus d’informations, consultez « Déploiements et environnements ».
1. Sélectionnez la règle de protection personnalisée que vous souhaitez activer.
2. Cliquez sur Enregistrer les règles de protection.
Si vous le souhaitez, vous pouvez spécifier les branches et les balises qui peuvent être déployées dans cet environnement. Pour plus d’informations, consultez « Déploiements et environnements ».
1. Sélectionnez l’option souhaitée dans la liste déroulante Branches de déploiement.
2. Si vous avez choisi Branches et balises sélectionnées, pour ajouter une nouvelle règle, cliquez sur Ajouter une règle de branche ou de balise de déploiement
3. Dans le menu déroulant « Type de référence », en fonction de la règle que vous souhaitez appliquer, cliquez sur Branche ou l’onglet .
4. Entrez le modèle de nom de la branche ou de la balise que vous souhaitez autoriser.
  
  Remarque
  
  Les modèles de nom doivent être configurés individuellement pour les branches ou les balises.
5. Cliquez sur Ajouter une règle.
Si vous le souhaitez, ajoutez des secrets d’environnement. Ces secrets sont disponibles uniquement pour les travaux de workflow qui utilisent l’environnement. En outre, les travaux de workflow qui utilisent cet environnement peuvent uniquement accéder à ces secrets après la validation des règles éventuellement configurées (par exemple, les réviseurs requis). Pour plus d’informations, consultez « Déploiements et environnements ».
1. Sous Secrets d’environnement, cliquez sur Ajouter un secret.
2. Entrez le nom du secret.
3. Entrez la valeur du secret.
4. Cliquez sur Ajouter un secret.
Si vous le souhaitez, ajoutez des variables d’environnement. Ces variables sont uniquement disponibles pour les travaux de workflow qui utilisent l’environnement, et sont uniquement accessibles à l’aide du contexte vars. Pour plus d’informations, consultez « Déploiements et environnements ».
1. Sous Variables d’environnement, cliquez sur Ajouter une variable.
2. Entrez le nom de la variable.
3. Entrez la valeur de la variable.
4. Cliquez sur Ajouter une variable.

Vous pouvez également créer et configurer des environnements via l’API REST. Pour plus d’informations, consultez « Points de terminaison d’API REST pour les environnements de déploiement », « Points de terminaison REST pour l’API secrets GitHub Actions », « Points de terminaison d’API REST pour les variables GitHub Actions » et « Points de terminaison d’API REST pour les stratégies de branche de déploiement ».

L’exécution d’un workflow qui référence un environnement qui n’existe pas crée un environnement avec le nom référencé. Si l'environnement est créé à partir de l'exécution de constructions de pages implicites (par exemple, à partir d'une branche ou d'un dossier source), la branche source sera ajoutée en tant que règle de protection à l'environnement. Sinon, l’environnement nouvellement créé n’aura pas de règles de protection ni de secrets configurés. Toute personne qui peut modifier des workflows dans le dépôt peut créer des environnements via un fichier de workflow, mais seuls les administrateurs de dépôt peuvent configurer l’environnement.

Suppression d’un environnement

Pour configurer un environnement dans un référentiel de comptes personnels, vous devez être le propriétaire du référentiel. Pour configurer un environnement dans un référentiel d’organisation, vous devez disposer d’un accès admin.

La suppression d’un environnement supprime toutes les règles de protection et tous les secrets associés à l’environnement. Tous les travaux actuellement en attente en raison de règles de protection de l’environnement supprimé échouent automatiquement.

Sur GitHub, accédez à la page principale du référentiel.
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, cliquez sur Environnements.
À côté de l’environnement que vous souhaitez supprimer, cliquez sur .
Cliquez sur Je comprends, supprimez cet environnement.

Vous pouvez également supprimer des environnements via l’API REST. Pour plus d’informations, consultez « Points de terminaison d’API REST pour les référentiels ».

Relation entre les environnements et les déploiements

Quand un travail de workflow qui référence un environnement s’exécute, il crée un objet de déploiement avec la propriété environment définie sur le nom de votre environnement. Au fur et à mesure que le workflow progresse, il crée aussi des objets d’état de déploiement avec la propriété environment définie sur le nom de votre environnement, la propriété environment_url définie sur l’URL de l’environnement (si elle est spécifiée dans le workflow) et la propriété state définie sur l’état du travail.

Vous pouvez accéder à ces objets via l’API REST ou l’API GraphQL. Vous pouvez également vous abonner à ces événements webhook. Pour plus d’informations, consultez « Points de terminaison d’API REST pour les référentiels », « Objets » (API GraphQL) ou « Événements et charges utiles du webhook ».

Étapes suivantes

GitHub Actions fournit plusieurs fonctionnalités pour la gestion de vos déploiements. Pour plus d’informations, consultez « Déploiement avec GitHub Actions ».