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 aux référentiels de code et de recevoir les événements de déploiement lors des enquêtes sur les incidents. Cette intégration suit un processus en deux étapes : enregistrement au niveau du compte GitHub, suivi de 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) et GitHub Enterprise Server (auto-hébergées).
Conditions préalables
Avant de vous connecter GitHub, assurez-vous d'avoir :
Accès à la console d'administration de AWS DevOps l'agent
Un compte GitHub utilisateur ou une organisation avec des autorisations d'administrateur
Autorisation d'installer GitHub des applications dans votre compte ou votre organisation
Pour GitHub Enterprise Server, vous devez également :
Une instance de serveur GitHub d'entreprise (version 3.x ou ultérieure) accessible via HTTPS
L'URL HTTPS de votre instance de serveur GitHub d'entreprise (par exemple,
https://github.example.com)(Facultatif) Une connexion privée, si votre instance de serveur GitHub d'entreprise n'est pas accessible au public
Inscription 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 Fonctionnalités
Dans la section Pipeline, choisissez Ajouter
Sélectionnez GitHubdans la liste des fournisseurs disponibles
Si ce GitHub n'est pas encore le cas, il vous sera demandé de l'enregistrer d'abord.
Étape 2 : Choisissez le type de connexion
Sur l'écran « Enregistrer un GitHub compte/une organisation », indiquez si vous vous connectez en tant qu'utilisateur ou en tant qu'organisation :
Utilisateur — Votre GitHub compte personnel avec un nom d'utilisateur et un profil
Organisation — Un GitHub compte partagé où plusieurs personnes peuvent collaborer sur de nombreux projets à la fois
Sélectionnez les autorisations d'GitHub 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 demande uniquement 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.
Si vous vous connectez à une instance de serveur GitHub d'entreprise, cochez la case Utiliser un serveur GitHub d'entreprise 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 final dans l'URL ; entrez uniquement l'URL de base.
Étape 3 : configurer l' GitHub application
Choisissez Soumettre pour commencer le processus de configuration de l'application. Les étapes suivantes varient selon que vous vous connectez à Enterprise Server GitHub.com ou à GitHub Enterprise Server.
Pour GitHub.com
Vous serez redirigé GitHub vers l' GitHub application AWS DevOps Agent pour y installer.
Sélectionnez le compte ou l'organisation dans lequel vous souhaitez installer l'application.
L'application permet à l' AWS DevOps agent de recevoir des événements provenant de référentiels connectés, y compris des événements de déploiement.
Pour GitHub Enterprise Server
GitHub Enterprise Server utilise un flux GitHub App Manifest, qui configure automatiquement une nouvelle GitHub application sur votre instance. Cela implique deux redirections vers votre instance GitHub Enterprise Server.
Votre navigateur sera redirigé vers la page « Créer une GitHub application » de votre instance GitHub Enterprise Server.
Vous verrez le nom de l'application prérempli. N'hésitez pas à modifier le nom selon vos besoins. Choisissez Create GitHub App.
Vous serez redirigé vers l' AWS DevOps Agent, qui échange le code manifeste contre les informations d'identification de l'application.
Étape 4 : sélectionner les référentiels et terminer l'installation
Vous verrez la page d'installation et d'autorisation de l' GitHub application.
Sélectionnez les référentiels auxquels l'application doit accéder :
Tous les référentiels : accordez l'accès à tous les référentiels actuels et futurs
Sélectionnez uniquement les référentiels : choisissez des référentiels spécifiques à partir de votre compte ou de votre organisation
Choisissez Installer et autoriser.
Vous serez redirigé vers la console de l' AWS DevOps agent, où GitHub vous serez enregistré au niveau du compte.
Connexion de référentiels à un espace d'agents
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 AWS DevOps Agent, sélectionnez votre espace agent
Accédez à l'onglet Fonctionnalités
Dans la section Pipeline, choisissez Ajouter
Sélectionnez GitHubdans 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 agent
Choisissez Ajouter pour terminer la connexion
Vous pouvez connecter différents ensembles de référentiels à différents espaces d'agent en fonction des besoins de votre organisation. Un seul agent Space peut utiliser des référentiels issus de plusieurs enregistrements. Pour ajouter des référentiels provenant 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 à l'étape de GitHub connexion, ils sont automatiquement ajoutés à la section Révision du code et tests automatisés. Cette section définit les référentiels qui déclenchent automatiquement un Révisions du code de préparation à la publication et les fonctionnalités de test automatisées.
La configuration de la révision du code et des tests automatisés inclut :
Fonctionnalités — Choisissez des fonctionnalités de révision du code et de test automatique pour chaque référentiel. La section fournit deux paramètres par référentiel :
Examen automatique des modifications par déclenchement : lorsqu'il est activé pour un référentiel, DevOps l'agent exécute automatiquement une pull request 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'examen apparaissent sous forme de commentaires intégrés sur la pull request. Ceci est activé par défaut pour tous les référentiels connectés.
Tests de vérification automatisés : lorsqu'il est activé pour un référentiel, DevOps l'agent crée, exécute et teste les modifications apportées au code dans un environnement de vérification géré lors de la révision du code. Cela permet une validation fonctionnelle allant au-delà de l'analyse statique. Pour plus d'informations, consultez la section Tests de vérification automatisés. Ceci est activé 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 comporte des cases à cocher indépendantes pour les deux fonctionnalités.
Rôle d'exécution (facultatif) — Choisissez le rôle IAM que l' DevOps agent assume pour exécuter les fonctionnalités automatisées sur les référentiels sélectionnés. Ce rôle est utilisé pour accéder 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, procédez comme suit :
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 automatique des modifications 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 ou non des tests de vérification automatisés dans un environnement de vérification géré.
Vous pouvez éventuellement sélectionner un rôle IAM dans la liste déroulante des rôles d'exécution que l' DevOps agent assumera lors de l'exécution des 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 pull request dans un référentiel où la révision des modifications par déclenchement automatique est activée déclenchera automatiquement une révision du code de préparation à la version. Si les tests de vérification automatisés sont également activés, la révision inclut la 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.
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 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 GitHub paramètres
Pour GitHub Enterprise Server, l' GitHub application est automatiquement créée 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 à Réglages > Paramètres du développeur > GitHub Applications.
GitHub Mises à jour des autorisations de
AWS DevOps L'agent peut demander des mises à jour des autorisations après avoir installé 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 jeton d'accès à l'installation suivant 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'enregistrement, l' GitHub application demande un accès en lecture uniquement pour chaque autorisation indiquée dans le tableau suivant. Avec les autorisations en lecture seule, l' GitHub application ne peut pas effectuer les actions de niveau écriture répertoriées dans la colonne Objectif.
| Autorisations | Niveau d’accès | Objectif |
|---|---|---|
| Chèques | Lisez et écrivez | La révision du code de préparation après la publication donne des résultats lorsque la vérification est exécutée sur les pull requests, ce qui permet d'afficher le statut de la révision directement dans l' GitHub interface utilisateur. |
| Flux de travail | Lisez et écrivez | Lisez les définitions des flux de travail et déclenchez GitHub les flux de travail Actions pour tester les versions dans vos CI/CD pipelines. |
| Actions | Lisez et écrivez | Surveillez GitHub les exécutions du flux de travail 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 une analyse de révision du code et un 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 des pull requests pour déclencher des révisions de code automatisées. L'accès par écrit permet de publier des commentaires d'évaluation en ligne contenant les résultats et les solutions recommandées. |
Gestion des GitHub connexions
Mise à jour de l'accès aux référentiels : pour modifier les référentiels auxquels GitHub l'application peut accéder, accédez aux paramètres de votre GitHub compte ou de votre organisation (ou aux paramètres de votre instance GitHub Enterprise Server), accédez 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 agent et accédez à l'onglet Fonctionnalités pour afficher les référentiels connectés dans la section Pipeline.
Suppression de la GitHub connexion : pour vous déconnecter GitHub d'un espace agent, sélectionnez la connexion dans la section Pipeline, puis choisissez Supprimer. Pour désinstaller complètement l' GitHub application, désinstallez-la dans les paramètres de votre GitHub compte ou de votre organisation. Pour GitHub Enterprise Server, étant donné que l' GitHub application est créée directement sur votre instance lors de l'enregistrement, vous pouvez éventuellement nettoyer entièrement l'application en effectuant les deux opérations suivantes :
Désinstaller 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 à Réglages > Paramètres du développeur > GitHub Applications, sélectionnez l'application, accédez à l'onglet Avancé, puis choisissez Supprimer GitHub l'application. Avertissement : La suppression de GitHub l'application est définitive et irréversible. Si vous le supprimez, vous devrez réenregistrer GitHub Enterprise Server depuis le début dans la console de l' AWS DevOps agent pour créer une nouvelle application.
