Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Connecter GitHub
GitHub l'intégration permet à l' AWS DevOps Agent d'accéder à des référentiels de code et de recevoir des événements de déploiement lors des enquêtes sur les incidents. Cette intégration suit un processus en deux étapes : l'enregistrement au niveau du compte GitHub, puis la connexion de référentiels spécifiques à des espaces d'agent individuels.
AWS DevOps L'agent prend en charge les instances GitHub.com (SaaS), GitHub Enterprise Cloud avec résidence des données (*.ghe.com) et GitHub Enterprise Server (auto-hébergées).
Vous pouvez vous inscrire GitHub de deux manières. L'enregistrement de l'application installe l' GitHub application AWS DevOps Agent sur votre compte ou votre organisation. L' GitHub application prend en charge les webhooks et les autorisations précises, et nous la recommandons pour la plupart des cas d'utilisation. Le jeton d'accès personnel s'authentifie à l'aide d'un jeton de votre GitHub compte. Utilisez-le pour un accès individuel lorsque vous n'avez pas besoin de fonctionnalités basées sur les webhooks. Pour plus d'informations, consultez la section Enregistrement GitHub à l'aide d'un jeton d'accès personnel.
Conditions préalables
Avant de vous connecter GitHub, vérifiez que vous remplissez les conditions préalables suivantes :
Vous avez accès à la console d'administration de l' AWS DevOps agent.
Vous disposez d'un compte GitHub utilisateur ou d'une organisation avec des droits d'administrateur.
Pour l'enregistrement des applications, vous êtes autorisé à installer GitHub des applications sur votre compte ou votre organisation.
Pour l'enregistrement d'un jeton d'accès personnel, vous disposez d'un jeton d'accès personnel avec les autorisations décrites dans Création d'un jeton d'accès personnel.
Pour GitHub Enterprise Server, confirmez également les points suivants :
Vous disposez d'une instance GitHub Enterprise Server (version 3.x ou ultérieure) accessible via HTTPS.
Vous disposez de l'URL HTTPS de votre instance GitHub Enterprise Server (par exemple,
https://github.example.com).(Facultatif) Vous disposez d'une connexion privée si votre instance GitHub Enterprise Server n'est pas accessible au public.
Pour GitHub Enterprise Cloud avec résidence des données, confirmez également les points suivants :
Vous disposez d'une organisation GitHub Enterprise Cloud avec la résidence des données activée, hébergée sur votre
*.ghe.comsous-domaine dédié.Vous disposez des autorisations d'administrateur de l'organisation, notamment de l'autorisation de créer et d'installer GitHub des applications.
Vous disposez de l'URL HTTPS de votre instance de résidence des données (par exemple,
https://octocorp.ghe.com).
Enregistrement GitHub (au niveau du compte)
GitHub est enregistré au niveau du AWS compte et partagé entre tous les espaces d'agent de ce compte. Chaque enregistrement correspond à un GitHub utilisateur, à une organisation ou à une instance GitHub d'Enterprise Server.
Étape 1 : Accédez aux fournisseurs de pipelines
Connectez-vous à la console AWS de gestion
Accédez à la console de AWS DevOps l'agent
Accédez à l'onglet Capacités
Dans la section Pipeline, choisissez Ajouter
Sélectionnez GitHub dans la liste des fournisseurs disponibles
Si vous GitHub n'êtes pas encore inscrit, vous serez d'abord invité à l'enregistrer.
Étape 2 : Choisissez le type de connexion
Sur l'écran Enregistrer le GitHub compte/l'organisation, sous Type de connexion, choisissez la manière dont AWS DevOps l'agent se connecte à GitHub :
Enregistrement de l'application (recommandé) — Installez l' GitHub application AWS DevOps Agent sur votre compte ou votre organisation. L' GitHub application prend en charge les webhooks et les autorisations affinées. Passez à l'étape 3.
Jeton d'accès personnel — Authentifiez-vous à l'aide d'un jeton d'accès personnel depuis votre GitHub compte. Cette option fournit un accès individuel et ne prend pas en charge les webhooks. Ignorez les étapes restantes de cette section et consultez la section Enregistrement à l' GitHub aide d'un jeton d'accès personnel.
Étape 3 : Configuration de l'enregistrement de GitHub l'application
Indiquez si vous vous connectez en tant qu'utilisateur ou organisation :
Utilisateur : votre GitHub compte personnel avec un nom d'utilisateur et un profil
Organisation : GitHub compte partagé sur lequel plusieurs personnes peuvent collaborer sur de nombreux projets à la fois. Si vous sélectionnez Organisation, entrez le nom de GitHub l'organisation. Le nom doit correspondre exactement au nom de votre GitHub organisation, car vous devez autoriser et installer l'application sur cette organisation en suivant les étapes suivantes.
Sélectionnez les autorisations de GitHub l'application pour votre GitHub application. Le niveau d'autorisation détermine les actions que l' GitHub application peut effectuer dans votre référentiel :
Lecture et écriture (par défaut) : l' GitHub application demande des autorisations de lecture et d'écriture. Cela active toutes les fonctionnalités. DevOps L'agent peut publier des commentaires sur les pull requests en ligne, proposer des correctifs et déclencher des flux de travail.
Lecture seule : l' GitHub application ne demande que des autorisations de lecture. DevOps L'agent peut consulter le code et les pull requests, mais ne peut pas publier de commentaires, proposer des correctifs ou déclencher des flux de travail.
Méthode de vérification
Dans Méthode de vérification, choisissez la manière dont l' AWS DevOps agent confirme que l' GitHub application est installée sur le compte ou l'organisation que vous avez indiqué :
Browser-based rappel (par défaut) — Une fois que vous avez choisi Soumettre, AWS DevOps l'agent vous redirige vers GitHub pour autoriser l' GitHub application et, si nécessaire, l'installer. Passez à l'étape 4.
Vérifiez à l'aide d'un jeton d'accès personnel — Entrez un jeton d'accès personnel. AWS DevOps L'agent utilise le jeton une fois pour confirmer que l' GitHub application est installée dans le compte ou l'organisation que vous avez spécifié, puis le supprime. Le jeton n'est pas stocké. L'inscription se termine lorsque vous choisissez Soumettre, sans aucune redirection vers GitHub.
Utilisez Verify avec un jeton d'accès personnel lorsque l' GitHub application est déjà installée. Par exemple, utilisez-le lorsque vous connectez la même organisation à partir d'un autre AWS compte ou d'une autre région. Si l' GitHub application n'est pas encore installée, enregistrez-vous d'abord avec Browser-based rappel.
Le jeton de vérification nécessite les autorisations suivantes :
Pour une organisation, le propriétaire du jeton doit être le propriétaire d'une organisation. Le jeton nécessite également l'autorisation de lecture de l'organisation. Pour un jeton classique, utilisez la
read:orglunette. Pour un jeton affiné, utilisez l'autorisation Administration : Read-only organisation.Pour un compte personnel, le jeton n'a pas besoin de champs d'application supplémentaires.
Note
La vérification à l'aide d'un jeton d'accès personnel n'est disponible que pour GitHub.com. Pour GitHub Enterprise Server et GitHub Enterprise Cloud avec résidence des données, utilisez le Browser-based callback.
Si vous vous connectez à une instance GitHub Enterprise Server, choisissez Utiliser GitHub Enterprise et entrez l'URL HTTPS de votre instance (par exemple,https://github.example.com).
Si votre instance GitHub Enterprise Server n'est pas accessible au public, vous pouvez éventuellement configurer une connexion privée pour permettre à l' AWS DevOps Agent d'accéder à votre instance en toute sécurité. Pour de plus amples informations, veuillez consulter Connexion à des outils hébergés en privé.
Note
N'incluez /api/v3 aucun chemin de fin dans l'URL. Entrez uniquement l'URL de base.
Pour GitHub Enterprise Cloud avec résidence des données, choisissez Utiliser GitHub Enterprise et entrez l'URL HTTPS de votre instance de résidence des données (par exemple,https://octocorp.ghe.com).
Étape 4 : Configuration de l' GitHub application
Choisissez Soumettre pour démarrer le processus de configuration de l'application. Les étapes suivantes varient selon que vous vous connectez à GitHub.com GitHub Enterprise Server ou GitHub Enterprise Cloud avec résidence de données.
Si vous avez choisi Vérifier à l'aide d'un jeton d'accès personnel à l'étape 3, l'enregistrement se termine sans redirection. Ignorez les étapes 4 et 5.
Pour GitHub.com
GitHub vous redirige pour vous connecter et autoriser l' AWS DevOps agent.
Passez en revue la demande d'autorisation et autorisez AWS DevOps l'agent.
Une fois que vous avez autorisé, l' AWS DevOps agent termine l'enregistrement. Si l' GitHub application n'est pas encore installée sur le compte ou l'organisation que vous avez spécifié, vous passez à la page d'installation (voir Étape 5). Si l'application est déjà installée, l'enregistrement se termine sans la réinstaller.
Après l'installation, l' AWS DevOps agent reçoit les événements de vos référentiels connectés, y compris les événements de déploiement.
Note
Vous devez autoriser et installer l'application sur le même utilisateur ou la même organisation que vous avez indiqué lors de l'enregistrement. Si vous autorisez ou installez sur un autre compte ou une autre organisation, l'enregistrement échoue et vous devez recommencer le processus en sélectionnant le compte ou l'organisation appropriés.
Note
AWS DevOps L'agent utilise une GitHub application distincte pour chaque niveau d'autorisation (lecture et écriture et lecture seule), et chaque application est autorisée indépendamment. GitHub mémorise une autorisation jusqu'à ce que vous la révoquiez sous Réglages > Applications > GitHub Applications autorisées. Si vous avez déjà autorisé l'application à ce niveau d'autorisation, vous GitHub pouvez ignorer l'écran d'autorisation. Si vous modifiez le niveau d'autorisation, vous GitHub invite à autoriser l'application correspondante pour la première fois.
Pour GitHub Enterprise Server et GitHub Enterprise Cloud avec résidence des données
GitHub Enterprise Server et GitHub Enterprise Cloud avec résidence des données utilisent tous deux le flux GitHub App Manifest, qui configure automatiquement une nouvelle GitHub application sur votre instance. Lors de la configuration, votre navigateur est redirigé deux fois : une fois vers votre instance et une fois de nouveau vers AWS DevOps Agent.
AWS DevOps L'agent redirige votre navigateur vers la page Créer une GitHub application de votre instance GitHub Enterprise.
Le nom de l'application est pré-rempli. Modifiez le nom si nécessaire, puis choisissez Créer une GitHub application.
Une fois que AWS DevOps l'agent a redirigé votre navigateur, il échange le code manifeste contre les informations d'identification de l'application.
Étape 5 : Sélectionnez les référentiels et terminez l'installation
Ignorez cette étape si l' GitHub application est déjà installée sur votre compte ou votre organisation.
La page Installer et autoriser de l' GitHub application s'affiche.
Sélectionnez les référentiels auxquels l'application doit accéder :
Tous les référentiels — Autoriser l'accès à tous les référentiels actuels et futurs
Sélectionnez uniquement des référentiels : choisissez des référentiels spécifiques depuis votre compte ou votre organisation
Choisissez Installer et autoriser.
Vous serez redirigé vers la console de l' AWS DevOps agent, où GitHub vous verrez apparaître comme étant enregistré au niveau du compte.
S'inscrire GitHub à l'aide d'un jeton d'accès personnel
L'enregistrement d'un jeton d'accès personnel permet de se connecter GitHub sans installer l' GitHub application AWS DevOps Agent. AWS DevOps L'agent stocke le jeton et l'utilise pour authentifier les demandes GitHub d'API en votre nom. Utilisez cette option lorsque vous ne pouvez pas installer d' GitHub application ou lorsque vous n'avez besoin que d'un accès individuel au référentiel sans fonctionnalités basées sur les webhooks.
L'enregistrement d'un jeton d'accès personnel prend en charge GitHub.com GitHub Enterprise Server et GitHub Enterprise Cloud avec résidence des données. Pour une instance GitHub d'Enterprise Server qui n'est pas accessible au public, vous pouvez utiliser une connexion privée.
Avant de choisir cette option, tenez compte des limites suivantes :
Pas de webhooks : n'envoie GitHub pas d'événements de webhook à un utilisateur d'enregistrement de jeton d'accès personnel. AWS DevOps L'agent ne reçoit pas d'événements en temps réel tels que les notifications de pull request, de push ou de déploiement. Les révisions automatisées du code de préparation à la publication et les tests de vérification automatisés ne se déclenchent pas pour les référentiels connectés via un enregistrement de jeton d'accès personnel. Vous pouvez toujours demander une révision du code de préparation à la publication via le chat de DevOps l'agent ou via les intégrations des agents de codage. Pour de plus amples informations, veuillez consulter Révisions du code de préparation à la publication. Si vous avez besoin d'événements en temps réel, utilisez l'inscription à l'application.
L'accès au référentiel suit le jeton : lorsque vous limitez l'enregistrement à une organisation, l' AWS DevOps agent répertorie les référentiels de cette organisation auxquels le jeton peut accéder. Lorsque vous connectez le compte personnel du propriétaire du jeton, AWS DevOps l'agent répertorie uniquement les référentiels détenus par le propriétaire du jeton. L'agent ne peut effectuer que les opérations autorisées par le jeton.
Aucune mise à jour du jeton : vous ne pouvez pas mettre à jour le jeton d'une GitHub inscription existante. Pour remplacer un jeton expiré ou modifié, désenregistrez l'enregistrement et GitHub réinscrivez-vous avec le nouveau jeton. Reconnectez ensuite les référentiels à vos espaces d'agent.
Création d'un jeton d'accès personnel
Créez le jeton GitHub avant de vous inscrire. Vous pouvez utiliser un jeton classique ou un jeton à grain fin.
Pour un jeton classique, sélectionnez les étendues suivantes :
repo— Obligatoire pour lire le contenu et les métadonnées du référentielread:org— Obligatoire lorsque vous étendez l'enregistrement à une organisation. AWS DevOps L'agent l'utilise pour confirmer que le propriétaire du jeton est un membre actif de l'organisation.
Pour un jeton affiné, configurez les éléments suivants :
Si vous limitez l'enregistrement à une organisation, définissez le propriétaire de la ressource sur cette organisation. Sélectionnez les référentiels auxquels AWS DevOps l'agent peut accéder.
Dans Autorisations du référentiel, accordez Contenu : Read-only et Métadonnées : Read-only.
Sous Autorisations de l'organisation, accordez aux membres : Read-only lorsque vous limitez l'enregistrement à une organisation.
Définissez une date d'expiration adaptée à votre politique de sécurité. AWS DevOps L'agent ne peut pas renouveler le jeton. Avant l'expiration du jeton, créez un nouveau jeton, désenregistrez l' GitHub enregistrement, puis enregistrez-vous à nouveau.
S'inscrire avec un jeton d'accès personnel
Sur l'écran Enregistrer GitHub un compte/une organisation, sous Type de connexion, choisissez Jeton d'accès personnel.
Dans Jeton d'accès personnel, saisissez votre jeton.
(Facultatif) Configurez les champs suivants :
GitHub organisation — Entrez le nom de l'organisation à laquelle l'enregistrement sera étendu. Le propriétaire du jeton doit être un membre actif de l'organisation. Laissez ce champ vide pour connecter le GitHub compte personnel du propriétaire du jeton. Ce champ est obligatoire lorsque vous entrez un GitHub Enterprise Cloud avec une URL de résidence des données.
GitHub URL d'entreprise : entrez l'URL racine HTTPS de votre instance GitHub Enterprise (par exemple,
https://github.example.comouhttps://octocorp.ghe.com). Cela s'applique à GitHub Enterprise Server et GitHub Enterprise Cloud avec résidence des données. Laissez ce champ vide pour vous connecter à GitHub.com. N'incluez/api/v3aucun chemin de randonnée.Connexion privée : si votre instance GitHub Enterprise Server n'est pas accessible au public, sélectionnez une connexion privée. Pour de plus amples informations, veuillez consulter Connexion à des outils hébergés en privé.
Choisissez Soumettre. AWS DevOps L'agent valide le jeton GitHub et confirme l'identité du propriétaire du jeton. Lorsque vous entrez dans une organisation, cela confirme également que le propriétaire du jeton est un membre actif de cette organisation.
Une fois l'enregistrement terminé, GitHub apparaît comme enregistré au niveau du compte. Connectez des référentiels à vos espaces d'agent comme décrit dans Connecter des référentiels à un espace d'agent.
Résolution des problèmes d'enregistrement des jetons d'accès personnels
Si l'enregistrement à l'aide d'un jeton d'accès personnel échoue, comparez le message d'erreur avec la liste suivante.
Invalid GitHub personal access token— Le jeton n'est pas valide ou a expiré. Créez un nouveau jeton et réessayez.GitHub personal access token does not have sufficient permissions— Ajoutez lereposcope à un jeton classique ou accordez un accès en lecture aux référentiels que vous souhaitez utiliser avec un jeton affiné.The GitHub token's user is not a member of organization "<name>"— Vérifiez le nom de l'organisation. Vérifiez que le jeton possède laread:orgportée (classique) ou que les membres de l'organisation ont un accès en lecture (affiné).membership in organization "<name>" is "<state>", not active— Le propriétaire du jeton a une invitation en attente auprès de l'organisation. Acceptez l'invitation et réessayez.Failed to reach GitHub— Vérifiez l'URL de l' GitHub entreprise et la configuration de votre réseau. Pour une connexion privée, consultezRésolution des problèmes liés aux connexions privées.A GitHub service for "<owner>" is already registered with this account— Le AWS compte est déjà enregistré pour ce GitHub compte ou cette organisation. Utilisez l'enregistrement existant ou annulez-le d'abord.
Les erreurs suivantes s'appliquent à Verify with a personal access token :
The DevOps Agent GitHub App is not installed on the requested organization or account— Inscrivez-vous d'abord avec Browser-based callback pour installer l' GitHub application, puis réessayez.You do not have permission to install or access the DevOps Agent GitHub App on this organization— Utilisez un GitHub compte doté des autorisations de propriétaire (administrateur) de l'organisation.GitHub App verification is only supported for github.com— Pour GitHub Enterprise Server et GitHub Enterprise Cloud avec résidence des données, utilisez le Browser-based callback.
Connecter des référentiels à un espace d'agent
Une fois enregistré GitHub au niveau du compte, vous pouvez connecter des référentiels spécifiques à des espaces d'agent individuels :
Dans la console de l' AWS DevOps agent, sélectionnez votre espace d'agent
Accédez à l'onglet Capacités
Dans la section Pipeline, choisissez Ajouter
Sélectionnez GitHub dans la liste des fournisseurs disponibles
Sélectionnez l' GitHub enregistrement qui contient les référentiels que vous souhaitez utiliser
Sélectionnez le sous-ensemble de référentiels correspondant à cet espace d'agent
Choisissez Ajouter pour terminer la connexion
Vous pouvez connecter différents ensembles de référentiels à différents espaces d'agents en fonction des besoins de votre organisation. Un seul espace d'agent peut utiliser des référentiels provenant de plusieurs enregistrements. Pour ajouter des référentiels à partir d'un autre enregistrement, répétez ces étapes.
Configuration de la révision du code et des tests automatisés
Lorsque vous sélectionnez des référentiels lors de l'étape de GitHub connexion, ils sont automatiquement ajoutés à la section Révision du code et tests automatisés. Cette section configure les référentiels qui déclenchent automatiquement a Révisions du code de préparation à la publication et les fonctionnalités de test automatisées.
Note
Les déclencheurs automatisés dépendent des événements webhook de l' GitHub application. Pour les référentiels connectés via l'enregistrement d'un jeton d'accès personnel, les révisions et les tests automatisés ne sont pas exécutés. Demandez plutôt une révision du code de préparation à la publication via le chat de DevOps l'agent ou les intégrations des agents de codage.
La configuration de révision du code et de tests automatisés inclut :
Fonctionnalités : choisissez des fonctionnalités de révision du code et de tests automatisés pour chaque référentiel. La section fournit deux paramètres par référentiel :
Révision automatique des modifications : lorsque cette option est activée pour un référentiel, DevOps l'agent s'exécute automatiquement à Révisions du code de préparation à la publication chaque fois qu'une pull request est ouverte ou mise à jour. Les résultats de l'évaluation apparaissent sous forme de commentaires en ligne sur la pull request. Cette option est activée par défaut pour tous les référentiels connectés.
Tests de vérification automatisés : lorsque cette option est activée pour un référentiel, DevOps l'Agent crée, exécute et teste les modifications de votre code dans un environnement de vérification géré lors des révisions de code. Cela permet une validation fonctionnelle au-delà de l'analyse statique. Pour plus d'informations, consultez la section Tests de vérification automatisés. Cette option est activée par défaut pour tous les référentiels connectés.
Liste des référentiels : affiche tous les référentiels que vous avez sélectionnés lors de l'étape de connexion. Utilisez le champ de recherche pour filtrer les référentiels par nom. Chaque référentiel possède des cases à cocher indépendantes pour les deux fonctionnalités.
Rôle d'exécution (facultatif) : choisissez le rôle IAM assumé par l' DevOps agent pour exécuter des fonctionnalités automatisées sur les référentiels que vous avez sélectionnés. Ce rôle est utilisé lors de l'accès aux services internes nécessaires lors des builds, tels que les registres de packages privés et les systèmes de stockage d'artefacts. Nous vous recommandons d'utiliser un rôle différent de votre rôle d'agent principal.
Pour configurer les révisions automatisées :
Après avoir connecté vos référentiels, accédez à la section Révision du code et tests automatisés dans vos paramètres GitHub d'intégration.
Pour chaque référentiel, activez ou désactivez la fonctionnalité de révision des modifications déclenchée automatiquement selon que vous souhaitez ou non des révisions automatiques des pull requests.
Pour chaque référentiel, activez ou désactivez la fonctionnalité de test de vérification automatique selon que vous souhaitez effectuer des tests de vérification automatisés dans un environnement de vérification géré.
Vous pouvez également sélectionner un rôle IAM dans la liste déroulante Rôle d'exécution que l' DevOps agent assumera lors de l'exécution de fonctionnalités automatisées sur les référentiels que vous avez sélectionnés.
Choisissez Enregistrer pour appliquer votre configuration.
Une fois configurée, toute nouvelle demande d'extraction dans un référentiel pour lequel la révision des modifications par déclenchement automatique est activée déclenchera automatiquement une révision du code de préparation à la publication. Si les tests de vérification automatisés sont également activés, l'examen inclut une validation fonctionnelle dans un environnement de vérification. Pour plus d'informations sur les révisions de code, consultezRévisions du code de préparation à la publication.
Paramètres avancés : filtres de déclenchement
Par défaut, un référentiel sur lequel la révision des modifications par déclenchement automatique est activée exécute une révision du code de préparation à la publication pour chaque événement de pull request applicable, sur n'importe quelle branche cible. Utilisez les paramètres avancés pour ajouter des filtres de déclenchement qui contrôlent exactement le moment où les révisions automatisées sont exécutées pour chaque référentiel.
Chaque filtre est un groupe de filtres qui combine deux conditions :
Branches cibles (obligatoire) : un ou plusieurs noms ou modèles de branches, saisis sous forme d'expressions régulières (par exemple,
mainourelease/.*). La révision ne se déclenche que lorsque la branche cible (de base) de la pull request correspond à l'un de ces modèles.Événements déclencheurs (facultatif) — Les événements de demande d'extraction qui déclenchent une révision : demande d'extraction prête à être révisée ou demande d'extraction rédigée. Laissez ce champ vide pour qu'il corresponde à tous les événements applicables.
Au sein d'un groupe de filtres, toutes les conditions doivent correspondre (ET). Vous pouvez ajouter plusieurs groupes de filtres, et une évaluation est déclenchée lorsqu'un groupe correspond (OU).
Pour configurer les filtres de déclenchement :
Ouvrez la section Paramètres avancés dans le flux de connexion. (Pour modifier les filtres d'une connexion existante, sélectionnez la connexion dans la section Pipeline, choisissez Modifier, puis ouvrez les paramètres avancés.)
Trouvez le référentiel que vous souhaitez configurer et sélectionnez l'onglet Révision des modifications.
Choisissez Ajouter un groupe de filtres, puis définissez les conditions du groupe :
Sous Branches cibles, entrez un nom ou un modèle de branche et appuyez sur Entrée ou choisissez Ajouter. Répétez l'opération pour ajouter d'autres motifs.
(Facultatif) Sous Événements déclencheurs, sélectionnez Demande d'extraction prête à être révisée, Demande d'extraction rédigée, ou les deux. Laissez-le vide pour qu'il corresponde à tous les événements.
(Facultatif) Choisissez à nouveau Ajouter un groupe de filtres pour exprimer d'autres conditions.
Choisissez Enregistrer pour appliquer votre configuration.
Vous pouvez définir jusqu'à 5 groupes de filtres par référentiel, avec un maximum de 20 modèles par groupe. Chaque modèle doit être une expression régulière valide de 256 caractères maximum. Si vous n'ajoutez aucun groupe de filtres, les évaluations se déclenchent sur tous les événements applicables pour toutes les branches cibles.
Comprendre l' GitHub application
L' GitHub application AWS DevOps Agent :
Demande l'accès à vos référentiels : vous pouvez consulter les autorisations spécifiques lors de l'installation de GitHub l'application
Reçoit les événements de déploiement et d'autres événements du référentiel
Permet à AWS DevOps l'agent de corréler les modifications de code avec les incidents opérationnels
Peut être désinstallé à tout moment via vos paramètres GitHub
Pour GitHub Enterprise Server et GitHub Enterprise Cloud avec résidence des données, AWS DevOps l'agent crée automatiquement l' GitHub application sur votre instance lors de l'enregistrement. Vous pouvez gérer l'accès au référentiel de l'application ou la désinstaller via Paramètres > Applications > GitHub Applications installées. Pour supprimer complètement la définition de l'application, accédez à Paramètres > Paramètres du développeur > GitHub Applications.
GitHub Mises à jour des autorisations des
AWS DevOps L'agent peut demander des mises à jour des autorisations après l'installation de l' GitHub application pour prendre en charge les nouvelles fonctionnalités. Lorsque cela se produit :
Vous recevrez une notification GitHub concernant la demande de mise à jour des autorisations.
Consultez les détails de la mise à jour pour comprendre quelles nouvelles autorisations sont demandées.
Choisissez Accepter les nouvelles autorisations pour accorder les autorisations mises à jour.
Aucune modification n'est requise dans votre service ou votre application. Une fois que vous avez accepté les autorisations mises à jour, le prochain jeton d'accès à l'installation demandé par GitHub l' AWS DevOps agent inclura automatiquement les nouvelles autorisations.
Note
Jusqu'à ce que vous acceptiez une mise à jour des autorisations, l' AWS DevOps Agent continue de fonctionner avec les autorisations précédemment accordées. Les nouvelles fonctionnalités qui dépendent des autorisations mises à jour ne seront pas disponibles tant que vous n'aurez pas approuvé la demande. L'application conservera ses autorisations actuelles si vous choisissez de ne pas accepter les nouvelles autorisations.
Autorisations demandées
Le tableau suivant décrit chaque autorisation demandée par l' GitHub application AWS DevOps Agent et explique pourquoi elle est nécessaire.
Si vous avez sélectionné Lecture seule lors de l'inscription, GitHub l'application demande un accès en lecture uniquement pour chaque autorisation du tableau suivant. Avec les autorisations de lecture seule, l' GitHub application ne peut pas effectuer les actions de niveau d'écriture répertoriées dans la colonne Objectif.
| Autorisation | Niveau d’accès | Objectif |
|---|---|---|
| Chèques | Lisez et écrivez | La révision du code de préparation après la publication est effectuée lorsque la vérification est exécutée sur les pull requests, ce qui permet à l'état de révision d'apparaître directement dans l' GitHub interface utilisateur. |
| Flux de travail | Lisez et écrivez | Lisez les définitions des flux de travail et déclenchez GitHub des flux de travail Actions pour tester les versions de vos CI/CD pipelines. |
| Actions | Lisez et écrivez | Surveillez GitHub les exécutions du flux de travail des actions et accédez aux journaux d'exécution lors des enquêtes sur les incidents et des tests de version. |
| Table des matières | Lisez et écrivez | Lisez le code source du référentiel pour l'analyse de la révision du code et le mappage des dépendances. L'accès en écriture permet à l'agent de proposer des solutions aux problèmes identifiés. |
| Demandes pull | Lisez et écrivez | Lisez les détails de la pull request pour déclencher des révisions de code automatisées. L'accès à la rédaction permet de publier des commentaires de révision en ligne contenant les résultats et les correctifs recommandés. |
| Administration de l'organisation | Lecture | Consultez la liste des applications installées dans l'organisation cible pour vérifier que l' GitHub application AWS DevOps Agent est installée. |
Gestion des GitHub connexions
Mise à jour de l'accès au référentiel — Pour modifier les référentiels auxquels l' GitHub application peut accéder, accédez aux paramètres de votre GitHub compte ou de votre organisation. Pour GitHub Enterprise Server ou GitHub Enterprise Cloud avec résidence des données, accédez aux paramètres de votre instance. Accédez ensuite aux GitHub applications installées et modifiez la configuration de l'application AWS DevOps Agent.
Affichage des référentiels connectés : dans la console de l' AWS DevOps agent, sélectionnez votre espace d'agent et accédez à l'onglet Fonctionnalités pour afficher les référentiels connectés dans la section Pipeline.
Remplacement d'un jeton d'accès personnel — Vous ne pouvez pas mettre à jour le jeton d'un GitHub enregistrement existant. Pour remplacer un jeton, désenregistrez l'enregistrement depuis la page Capability Providers. Enregistrez-vous ensuite GitHub à nouveau avec le nouveau jeton et reconnectez les référentiels à vos espaces d'agent. Révoquez l'ancien jeton dans vos GitHub paramètres.
Suppression de la GitHub connexion : pour vous GitHub déconnecter d'un espace d'agent, choisissez la connexion dans la section Pipeline, puis choisissez Supprimer. Pour supprimer l' GitHub enregistrement de votre compte, accédez à la page Capability Providers, localisez votre inscription dans la GitHub section et choisissez Désenregistrer.
Pour supprimer complètement l' GitHub intégration, procédez comme suit :
Pour désinstaller l' GitHub application, accédez aux paramètres de votre GitHub compte ou de votre organisation.
Pour vous reconnecter, enregistrez-vous de nouveau GitHub dans la console de l' AWS DevOps agent.
Pour GitHub Enterprise Server et GitHub Enterprise Cloud avec résidence des données, l' AWS DevOps agent crée l' GitHub application sur votre instance lors de l'enregistrement. Pour nettoyer complètement l'application, effectuez les deux opérations suivantes :
Désinstallez l'application : accédez à Paramètres > Applications > GitHub Applications installées, choisissez Configurer dans l'application, puis désinstallez-la.
Supprimer l'application — Accédez à Paramètres > Paramètres pour développeurs > GitHub Applications, choisissez l'application, accédez à l'onglet Avancé, puis choisissez Supprimer GitHub l'application. Avertissement : La suppression de GitHub l'application est définitive et ne peut pas être annulée. Pour créer une nouvelle application, enregistrez-vous de nouveau GitHub dans la console de l' AWS DevOps agent.
