Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Verbindung herstellen GitHub
GitHub Die Integration ermöglicht es dem AWS DevOps Agenten, auf Code-Repositorys zuzugreifen und Einsatzereignisse während der Untersuchung von Vorfällen zu empfangen. Diese Integration folgt einem zweistufigen Prozess: Registrierung von bestimmten Repositorys auf Kontoebene GitHub, gefolgt von der Verbindung bestimmter Repositorys mit einzelnen Agent Spaces.
AWS DevOps Agent Supports GitHub.com (SaaS), GitHub Enterprise Cloud mit Data Residency (*.ghe.com) und GitHub Enterprise Server (selbst gehostet) Instanzen.
Sie können sich auf zwei GitHub Arten registrieren. Durch die App-Registrierung wird die AWS DevOps GitHub Agenten-App in Ihrem Konto oder Ihrer Organisation installiert. Die GitHub App unterstützt Webhooks und detaillierte Berechtigungen, und wir empfehlen sie für die meisten Anwendungsfälle. Das persönliche Zugriffstoken authentifiziert sich mit einem Token aus Ihrem Konto. GitHub Verwenden Sie es für den individuellen Zugriff, wenn Sie keine Webhook-basierten Funktionen benötigen. Weitere Informationen finden Sie unter Registrierung GitHub mit einem persönlichen Zugriffstoken.
Voraussetzungen
Bevor Sie eine Verbindung herstellen GitHub, stellen Sie sicher, dass Sie die folgenden Voraussetzungen erfüllen:
Sie haben Zugriff auf die AWS DevOps Agent-Verwaltungskonsole.
Sie haben ein GitHub Benutzerkonto oder eine Organisation mit Administratorrechten.
Für die App-Registrierung sind Sie berechtigt, GitHub Apps in Ihrem Konto oder Ihrer Organisation zu installieren.
Für die Registrierung eines persönlichen Zugriffstokens verfügen Sie über ein persönliches Zugriffstoken mit den unter Erstellen eines persönlichen Zugriffstokens beschriebenen Berechtigungen.
Bestätigen Sie für GitHub Enterprise Server außerdem Folgendes:
Sie haben eine GitHub Enterprise Server-Instanz (Version 3.x oder höher), auf die über HTTPS zugegriffen werden kann.
Sie haben die HTTPS-URL Ihrer GitHub Enterprise Server-Instanz (zum Beispiel
https://github.example.com).(Optional) Sie haben eine private Verbindung, wenn Ihre GitHub Enterprise Server-Instanz nicht öffentlich zugänglich ist.
Bestätigen Sie für GitHub Enterprise Cloud mit Datenresidenz außerdem Folgendes:
Sie haben eine GitHub Enterprise Cloud-Organisation mit aktivierter Datenresidenz, die auf Ihrer dedizierten
*.ghe.comSubdomain gehostet wird.Sie haben Administratorrechte für die Organisation, einschließlich der Erlaubnis, Apps zu erstellen und zu installieren GitHub .
Sie haben die HTTPS-URL Ihrer Data Residency-Instanz (zum Beispiel
https://octocorp.ghe.com).
Registrierung GitHub (auf Kontoebene)
GitHub wird auf AWS Kontoebene registriert und von allen Agent Spaces in diesem Konto gemeinsam genutzt. Jede Registrierung entspricht einem GitHub Benutzer, einer Organisation oder einer GitHub Enterprise Server-Instanz.
Schritt 1: Navigieren Sie zu den Pipeline-Anbietern
Melden Sie sich bei der AWS Management Console an
Navigieren Sie zur AWS DevOps Agent-Konsole
Gehen Sie zur Registerkarte „Funktionen“
Wählen Sie im Abschnitt Pipeline die Option Hinzufügen aus
Wählen Sie GitHub aus der Liste der verfügbaren Anbieter aus
Wenn Sie GitHub noch nicht registriert sind, werden Sie aufgefordert, es zuerst zu registrieren.
Schritt 2: Wählen Sie den Verbindungstyp
Wählen Sie auf dem Bildschirm GitHub Konto /Organisation registrieren unter Verbindungstyp aus, wie der AWS DevOps Agent eine Verbindung herstellt zu GitHub:
App-Registrierung (empfohlen) — Installieren Sie die AWS DevOps GitHub Agenten-App in Ihrem Konto oder Ihrer Organisation. Die GitHub App unterstützt Webhooks und detaillierte Berechtigungen. Fahren Sie mit Schritt 3 fort.
Persönliches Zugriffstoken — Authentifizieren Sie sich mit einem persönlichen Zugriffstoken aus Ihrem GitHub Konto. Diese Option bietet individuellen Zugriff und unterstützt keine Webhooks. Überspringen Sie die verbleibenden Schritte in diesem Abschnitt. Weitere Informationen finden Sie unter Registrierung GitHub mit einem persönlichen Zugriffstoken.
Schritt 3: Konfigurieren Sie die GitHub App-Registrierung
Wählen Sie aus, ob Sie als Benutzer oder Organisation eine Verbindung herstellen:
Nutzer — Ihr persönliches GitHub Konto mit einem Nutzernamen und einem Profil
Organisation — Ein gemeinsames GitHub Konto, in dem mehrere Personen an vielen Projekten gleichzeitig zusammenarbeiten können. Wenn Sie Organisation auswählen, geben Sie den Namen der GitHub Organisation ein. Der Name muss exakt mit dem Namen Ihrer GitHub Organisation übereinstimmen, da Sie die App in den folgenden Schritten für diese Organisation autorisieren und installieren müssen.
Wählen Sie die GitHub App-Berechtigungen für Ihre GitHub App aus. Die Berechtigungsstufe bestimmt die Aktionen, die die GitHub App in deinem Repository ausführen kann:
Lesen und Schreiben (Standard): Die GitHub App fordert sowohl Lese- als auch Schreibberechtigungen an. Dadurch werden alle Funktionen aktiviert. DevOps Der Agent kann Inline-Pull-Request-Kommentare posten, Korrekturen vorschlagen und Workflows auslösen.
Nur lesen: Die GitHub App fordert nur Leseberechtigungen an. DevOps Der Agent kann Code- und Pull-Requests einsehen, aber keine Kommentare posten, Korrekturen vorschlagen oder Workflows auslösen.
Methode zur Überprüfung
Wählen Sie unter Bestätigungsmethode aus, wie der AWS DevOps Agent bestätigt, dass die GitHub App in dem von Ihnen angegebenen Konto oder der Organisation installiert ist:
Browser-based Rückruf (Standard) — Nachdem Sie auf Senden geklickt haben, leitet Sie der AWS DevOps Agent weiter, GitHub um die GitHub App zu autorisieren und bei Bedarf zu installieren. Fahren Sie mit Schritt 4 fort.
Mit einem persönlichen Zugriffstoken verifizieren — Geben Sie ein persönliches Zugriffstoken ein. AWS DevOps Der Agent verwendet das Token einmal, um zu bestätigen, dass die GitHub App in dem von Ihnen angegebenen Konto oder der Organisation installiert ist, und verwirft es dann. Das Token wird nicht gespeichert. Die Registrierung ist abgeschlossen, wenn Sie auf Senden klicken, ohne dass eine Weiterleitung zu GitHub erfolgt.
Verwenden Sie Verify mit einem persönlichen Zugriffstoken, wenn die GitHub App bereits installiert ist. Verwenden Sie es beispielsweise, wenn Sie dieselbe Organisation von einem anderen AWS Konto oder einer anderen Region aus verbinden. Wenn die GitHub App noch nicht installiert ist, registrieren Sie sich zuerst mit Browser-based Callback.
Das Verifizierungstoken benötigt die folgenden Berechtigungen:
Für eine Organisation muss der Token-Besitzer ein Organisationsinhaber sein. Das Token benötigt außerdem eine Leseberechtigung der Organisation. Verwenden Sie für ein klassisches Token den
read:orgGültigkeitsbereich. Verwenden Sie für ein detailliertes Token die Berechtigung Administration: Read-only Organisation.Für ein persönliches Konto benötigt das Token keine zusätzlichen Gültigkeitsbereiche.
Anmerkung
Die Überprüfung mit einem persönlichen Zugriffstoken ist nur für GitHub.com verfügbar. Verwenden Sie für GitHub GitHub Enterprise Server und Enterprise Cloud mit Datenresidenz Browser-based Callback.
Wenn Sie eine Verbindung zu einer GitHub Enterprise Server-Instanz herstellen, wählen Sie Use GitHub Enterprise und geben Sie die HTTPS-URL Ihrer Instanz ein (z. B.https://github.example.com).
Wenn Ihre GitHub Enterprise Server-Instanz nicht öffentlich zugänglich ist, können Sie optional eine private Verbindung konfigurieren, damit der AWS DevOps Agent Ihre Instance sicher erreichen kann. Weitere Informationen finden Sie unter Verbindung zu privat gehosteten Tools herstellen.
Anmerkung
Geben /api/v3 Sie in der URL keinen nachfolgenden Pfad ein — geben Sie nur die Basis-URL ein.
Wählen Sie für GitHub Enterprise Cloud mit Datenresidenz die Option Use GitHub Enterprise aus und geben Sie die HTTPS-URL Ihrer Datenresidenzinstanz ein (z. B.). https://octocorp.ghe.com
Schritt 4: Richten Sie die App ein GitHub
Wählen Sie Senden, um mit der Einrichtung der App zu beginnen. Die nächsten Schritte unterscheiden sich je nachdem GitHub.com, ob Sie eine Verbindung zu GitHub Enterprise Server oder GitHub Enterprise Cloud mit Datenresidenz herstellen.
Wenn Sie in Schritt 3 die Option Mit einem persönlichen Zugriffstoken verifizieren ausgewählt haben, wird die Registrierung ohne Weiterleitung abgeschlossen. Überspringen Sie Schritt 4 und Schritt 5.
Für GitHub.com
GitHub leitet Sie weiter, sich anzumelden und den AWS DevOps Agenten zu autorisieren.
Prüfen Sie die Autorisierungsanfrage und autorisieren Sie AWS DevOps den Agenten.
Nach der Autorisierung schließt der AWS DevOps Agent die Registrierung ab. Wenn die GitHub App noch nicht auf dem Konto oder der Organisation installiert ist, die Sie angegeben haben, fahren Sie mit der Installationsseite fort (siehe Schritt 5). Wenn die App bereits installiert ist, wird die Registrierung abgeschlossen, ohne sie erneut zu installieren.
Nach der Installation empfängt der AWS DevOps Agent Ereignisse von Ihren verbundenen Repositorys, einschließlich Bereitstellungsereignissen.
Anmerkung
Sie müssen die App für denselben Benutzer oder dieselbe Organisation autorisieren und installieren, die Sie bei der Registrierung angegeben haben. Wenn Sie die Autorisierung oder Installation auf einem anderen Konto oder einer anderen Organisation vornehmen, schlägt die Registrierung fehl und Sie müssen den Vorgang erneut starten und das richtige Konto oder die richtige Organisation auswählen.
Anmerkung
AWS DevOps Der Agent verwendet für jede Berechtigungsstufe (Lesen und Schreiben und Nur Lesen) eine separate GitHub App, und jede App wird unabhängig autorisiert. GitHub merkt sich eine Autorisierung, bis Sie sie unter Einstellungen > Anwendungen > Autorisierte GitHub Apps widerrufen. Wenn Sie die App zuvor auf dieser Berechtigungsstufe autorisiert haben, überspringen Sie GitHub möglicherweise den Autorisierungsbildschirm. Wenn Sie die Berechtigungsstufe ändern, GitHub werden Sie aufgefordert, die entsprechende App beim ersten Mal zu autorisieren.
Für GitHub Enterprise Server und GitHub Enterprise Cloud mit Datenresidenz
GitHub Enterprise Server und GitHub Enterprise Cloud mit Datenresidenz verwenden beide den GitHub App-Manifest-Flow, der automatisch eine neue GitHub App auf Ihrer Instanz einrichtet. Während der Einrichtung wird Ihr Browser zweimal umgeleitet: einmal zu Ihrer Instanz und einmal zurück zu AWS DevOps Agent.
AWS DevOps Der Agent leitet Ihren Browser auf die Seite „ GitHub App erstellen“ Ihrer GitHub Enterprise-Instanz weiter.
Der App-Name ist vorausgefüllt. Ändern Sie bei Bedarf den Namen und wählen Sie dann „ GitHub App erstellen“.
Nachdem der AWS DevOps Agent Ihren Browser zurückgeleitet hat, tauscht er den Manifestcode gegen App-Anmeldeinformationen aus.
Schritt 5: Wählen Sie Repositorys aus und schließen Sie die Installation ab
Überspringen Sie diesen Schritt, wenn die GitHub App bereits in Ihrem Konto oder Ihrer Organisation installiert ist.
Die Seite „Installieren und autorisieren“ für die GitHub App wird angezeigt.
Wählen Sie aus, auf welche Repositorys die App zugreifen darf:
Alle Repositorys — Gewähren Sie Zugriff auf alle aktuellen und zukünftigen Repositorys
Nur ausgewählte Repositorys — Wähle bestimmte Repositorys aus deinem Konto oder deiner Organisation
Wähle Installieren und autorisieren.
Sie werden zurück zur AWS DevOps Agenten-Konsole weitergeleitet, wo als auf Kontoebene registriert angezeigt GitHub wird.
Registrierung GitHub mit einem persönlichen Zugriffstoken
Eine Registrierung mit einem persönlichen Zugriffstoken stellt eine Verbindung her, GitHub ohne die AWS DevOps GitHub Agent-App zu installieren. AWS DevOps Der Agent speichert das Token und verwendet es, um GitHub API-Anfragen in Ihrem Namen zu authentifizieren. Verwenden Sie diese Option, wenn Sie eine GitHub App nicht installieren können oder wenn Sie nur individuellen Repository-Zugriff ohne Webhook-basierte Funktionen benötigen.
Eine persönliche Zugriffstoken-Registrierung unterstützt GitHub.com GitHub Enterprise Server und GitHub Enterprise Cloud mit Datenresidenz. Für eine GitHub Enterprise Server-Instanz, die nicht öffentlich zugänglich ist, können Sie eine private Verbindung verwenden.
Beachten Sie die folgenden Einschränkungen, bevor Sie sich für diese Option entscheiden:
Keine Webhooks — sendet GitHub keine Webhook-Ereignisse an eine persönliche Zugriffstoken-Registrierung. AWS DevOps Der Agent erhält keine Echtzeitereignisse wie Pull-Request-, Push- oder Deployment-Benachrichtigungen. Bei Repositorys, die über eine persönliche Zugriffstoken-Registrierung verbunden sind, werden automatische Codeüberprüfungen und automatische Verifizierungstests nicht ausgelöst. Sie können weiterhin über den DevOps Agenten-Chat oder über die Coding-Agent-Integrationen eine Code-Überprüfung der Release-Readiness anfordern. Weitere Informationen finden Sie unter Readiness-Code-Reviews. Wenn Sie Ereignisse in Echtzeit benötigen, verwenden Sie die App-Registrierung.
Der Repository-Zugriff folgt dem Token — Wenn Sie die Registrierung auf eine Organisation übertragen, listet der AWS DevOps Agent die Repositorys in dieser Organisation auf, auf die das Token zugreifen kann. Wenn Sie das persönliche Konto des Token-Besitzers verbinden, listet der AWS DevOps Agent nur die Repositorys auf, die der Token-Besitzer besitzt. Der Agent kann nur die Operationen ausführen, die das Token zulässt.
Keine Token-Aktualisierung — Sie können das Token einer vorhandenen GitHub Registrierung nicht aktualisieren. Um ein abgelaufenes oder rotiertes Token zu ersetzen, melden Sie die Registrierung ab und registrieren Sie sich GitHub erneut mit dem neuen Token. Verbinden Sie dann die Repositorys erneut mit Ihren Agent Spaces.
Ein persönliches Zugriffstoken erstellen
Erstellen Sie das Token, GitHub bevor Sie sich registrieren. Sie können ein klassisches Token oder ein feinkörniges Token verwenden.
Wählen Sie für ein klassisches Token die folgenden Bereiche aus:
repo— Erforderlich, um Repository-Inhalte und Metadaten zu lesenread:org— Erforderlich, wenn Sie die Registrierung auf eine Organisation übertragen. AWS DevOps Der Agent verwendet es, um zu bestätigen, dass der Token-Besitzer ein aktives Mitglied der Organisation ist.
Für ein detailliertes Token konfigurieren Sie Folgendes:
Wenn Sie die Registrierung auf eine Organisation beschränken, geben Sie als Ressourcenbesitzer diese Organisation an. Wählen Sie die Repositorys aus, auf die der AWS DevOps Agent zugreifen kann.
Gewähren Sie unter Repository-Berechtigungen die Optionen Inhalt: Read-only und Metadaten: Read-only.
Gewähren Sie unter Organisationsberechtigungen Mitglieder:, Read-only wenn Sie die Registrierung auf eine Organisation übertragen.
Legen Sie ein Ablaufdatum fest, das Ihren Sicherheitsrichtlinien entspricht. AWS DevOps Der Agent kann das Token nicht erneuern. Bevor das Token abläuft, erstellen Sie ein neues Token, heben Sie die GitHub Registrierung ab und registrieren Sie sich erneut.
Registrierung mit einem persönlichen Zugriffstoken
Schließen Sie Schritt 1 ab: Navigieren Sie zu den Pipeline-Anbietern.
Wählen Sie auf dem Bildschirm GitHub Konto registrieren/Organisation unter Verbindungstyp die Option Persönliches Zugriffstoken aus.
Geben Sie im Feld Persönliches Zugriffstoken Ihr Token ein.
(Optional) Konfigurieren Sie die folgenden Felder:
GitHub Organisation — Geben Sie den Namen der Organisation ein, auf die die Registrierung beschränkt werden soll. Der Token-Besitzer muss ein aktives Mitglied der Organisation sein. Lassen Sie dieses Feld leer, um das persönliche GitHub Konto des Token-Besitzers zu verbinden. Dieses Feld ist erforderlich, wenn Sie eine GitHub Enterprise Cloud mit einer URL zur Datenresidenz eingeben.
GitHub Unternehmens-URL — Geben Sie die HTTPS-Root-URL Ihrer GitHub Enterprise-Instanz ein (z. B.
https://github.example.comoderhttps://octocorp.ghe.com). Dies gilt für GitHub Enterprise Server und GitHub Enterprise Cloud mit Datenresidenz. Lassen Sie dieses Feld leer, um eine Verbindung herzustellen GitHub.com. Geben Sie keinen nachfolgenden Pfad an./api/v3Private Verbindung — Wenn Ihre GitHub Enterprise Server-Instanz nicht öffentlich zugänglich ist, wählen Sie eine private Verbindung. Weitere Informationen finden Sie unter Verbindung zu privat gehosteten Tools herstellen.
Wählen Sie Senden aus. AWS DevOps Der Agent validiert das Token mit dem Token-Besitzer GitHub und bestätigt dessen Identität. Wenn Sie eine Organisation eingeben, wird auch bestätigt, dass der Token-Besitzer ein aktives Mitglied dieser Organisation ist.
Nach Abschluss der Registrierung wird es auf Kontoebene als registriert GitHub angezeigt. Verbinden Sie Repositorys mit Ihren Agent Spaces, wie unter Repositorys mit einem Agent Space verbinden beschrieben.
Fehlerbehebung bei der Registrierung von persönlichen Zugriffstokens
Wenn die Registrierung mit einem persönlichen Zugriffstoken fehlschlägt, vergleichen Sie die Fehlermeldung mit der folgenden Liste.
Invalid GitHub personal access token— Das Token ist ungültig oder abgelaufen. Erstellen Sie ein neues Token und versuchen Sie es erneut.GitHub personal access token does not have sufficient permissions— Fügen Sie denrepoBereich einem klassischen Token hinzu oder gewähren Sie Lesezugriff auf die Repositorys, die Sie verwenden möchten, mit einem feinkörnigen Token.The GitHub token's user is not a member of organization "<name>"— Überprüfen Sie den Namen der Organisation. Vergewissern Sie sich, dass das Token denread:orgGültigkeitsbereich (klassisch) oder den Lesezugriff der Organisationsmitglieder (feinkörnig) hat.membership in organization "<name>" is "<state>", not active— Der Token-Besitzer hat eine ausstehende Einladung an die Organisation. Nehmen Sie die Einladung an und versuchen Sie es erneut.Failed to reach GitHub— Überprüfen Sie die GitHub Unternehmens-URL und Ihre Netzwerkkonfiguration. Informationen zu einer privaten Verbindung finden Sie unterProblembehandlung bei privaten Verbindungen.A GitHub service for "<owner>" is already registered with this account— Das AWS Konto hat bereits eine Registrierung für dieses GitHub Konto oder diese Organisation. Verwenden Sie die bestehende Registrierung oder melden Sie sie zuerst ab.
Die folgenden Fehler gelten für Verify mit einem persönlichen Zugriffstoken:
The DevOps Agent GitHub App is not installed on the requested organization or account— Registrieren Sie sich zuerst mit Browser-based Callback, um die GitHub App zu installieren, und versuchen Sie es dann erneut.You do not have permission to install or access the DevOps Agent GitHub App on this organization— Verwenden Sie ein GitHub Konto mit Inhaberrechten (Admin) für die Organisation.GitHub App verification is only supported for github.com— Verwenden Sie für GitHub Enterprise Server und GitHub Enterprise Cloud mit Datenresidenz die Option Browser-based Callback.
Repositorys mit einem Agent Space verbinden
Nach der Registrierung GitHub auf Kontoebene können Sie bestimmte Repositorys mit einzelnen Agent Spaces verbinden:
Wählen Sie in der AWS DevOps Agent-Konsole Ihren Agent Space aus
Gehen Sie zur Registerkarte „Funktionen“
Wählen Sie im Abschnitt Pipeline die Option Hinzufügen
Wählen Sie GitHub aus der Liste der verfügbaren Anbieter
Wählen Sie die GitHub Registrierung aus, die die Repositorys enthält, die Sie verwenden möchten
Wählen Sie die Teilmenge der Repositorys aus, die für diesen Agent Space relevant sind
Wählen Sie Hinzufügen, um die Verbindung abzuschließen
Sie können je nach Unternehmensanforderungen verschiedene Gruppen von Repositorys mit verschiedenen Agent Spaces verbinden. Ein einzelner Agent Space kann Repositorys aus mehreren Registrierungen verwenden. Um Repositorys aus einer anderen Registrierung hinzuzufügen, wiederholen Sie diese Schritte.
Konfiguration der Codeüberprüfung und des automatisierten Testens
Wenn Sie im GitHub Verbindungsschritt Repositorys auswählen, werden sie automatisch zum Abschnitt Codeüberprüfung und automatisiertes Testen hinzugefügt. In diesem Abschnitt wird konfiguriert, welche Repositorys automatisch eine Readiness-Code-Reviews und automatische Testfunktionen auslösen.
Anmerkung
Automatisierte Trigger hängen von Webhook-Ereignissen aus der App ab. GitHub Bei Repositorys, die über eine persönliche Zugriffstoken-Registrierung verbunden sind, werden automatische Überprüfungen und automatische Tests nicht ausgeführt. Fordern Sie stattdessen über den DevOps Agenten-Chat oder die Coding-Agent-Integrationen eine Codeüberprüfung der Release-Readiness an.
Die Konfiguration für Codeüberprüfung und automatisiertes Testen umfasst:
Funktionen — Wählen Sie für jedes Repository Funktionen zur Codeüberprüfung und zum automatisierten Testen aus. Der Abschnitt enthält zwei Einstellungen pro Repository:
Change Review automatisch auslösen — Wenn diese Option für ein Repository aktiviert ist, wird der DevOps Agent automatisch Readiness-Code-Reviews jedes Mal ausgeführt, wenn ein Pull Request geöffnet oder aktualisiert wird. Die Ergebnisse der Überprüfung werden als Inline-Kommentare auf dem Pull Request angezeigt. Dies ist standardmäßig für alle verbundenen Repositorys aktiviert.
Automatisierter Verifizierungstest — Wenn der DevOps Agent für ein Repository aktiviert ist, erstellt, führt und testet er Ihre Codeänderungen während der Code-Reviews in einer verwalteten Überprüfungsumgebung. Dies ermöglicht eine funktionale Validierung, die über die statische Analyse hinausgeht. Weitere Informationen finden Sie unter Automatisierte Verifizierungstests. Dies ist standardmäßig für alle verbundenen Repositorys aktiviert.
Repository-Liste — Zeigt alle Repositorys an, die Sie während des Verbindungsschritts ausgewählt haben. Verwenden Sie das Suchfeld, um Repositorys nach Namen zu filtern. Jedes Repository hat unabhängige Checkboxen für beide Funktionen.
Runtime-Rolle (optional) — Wählen Sie die IAM-Rolle aus, die der DevOps Agent annimmt, um automatisierte Funktionen auf Ihren ausgewählten Repositorys auszuführen. Diese Rolle wird verwendet, wenn Sie auf interne Dienste zugreifen, die während der Erstellung benötigt werden, z. B. private Paketregistrierungen und Artefakt-Speichersysteme. Wir empfehlen, eine andere Rolle als Ihre primäre Agentenrolle zu verwenden.
So konfigurieren Sie automatische Bewertungen:
Nachdem Sie Ihre Repositorys verbunden haben, navigieren Sie in Ihren GitHub Integrationseinstellungen zum Abschnitt Codeüberprüfung und automatisiertes Testen.
Aktiviere oder deaktiviere für jedes Repository die Funktion zum automatischen Auslösen von Change-Reviews, je nachdem, ob du automatische Pull-Request-Reviews möchtest.
Aktiviere oder deaktiviere für jedes Repository die Funktion für automatische Verifizierungstests, je nachdem, ob du automatisierte Verifizierungstests in einer verwalteten Verifikationsumgebung möchtest.
Wählen Sie optional eine IAM-Rolle aus dem Drop-down-Menü für die Runtime-Rolle aus, die der DevOps Agent übernimmt, wenn er automatisierte Funktionen auf Ihren ausgewählten Repositorys ausführt.
Wählen Sie Speichern, um Ihre Konfiguration zu übernehmen.
Nach der Konfiguration löst jeder neue Pull Request in einem Repository, in dem die automatische Überprüfung von Änderungen ausgelöst wurde, automatisch eine Codeüberprüfung der Release-Bereitschaft aus. Wenn auch automatisierter Verifizierungstest aktiviert ist, umfasst die Überprüfung die Funktionsvalidierung in einer Verifikationsumgebung. Weitere Informationen zu Codeüberprüfungen finden Sie unterReadiness-Code-Reviews.
Erweiterte Einstellungen: Triggerfilter
Standardmäßig führt ein Repository, bei dem die automatische Trigger-Change-Überprüfung aktiviert ist, bei jedem zutreffenden Pull-Request-Ereignis und in jedem Ziel-Branch eine Codeüberprüfung der Release-Bereitschaft durch. Verwende die erweiterten Einstellungen, um Triggerfilter hinzuzufügen, die genau steuern, wann automatische Reviews für jedes Repository ausgeführt werden.
Jeder Filter ist eine Filtergruppe, die zwei Bedingungen kombiniert:
Zielzweige (erforderlich) — Ein oder mehrere Zweignamen oder Muster, die als reguläre Ausdrücke eingegeben werden (z. B.
mainoderrelease/.*). Die Überprüfung wird nur ausgelöst, wenn der Ziel-Branch (Basis-Branch) des Pull Requests einem dieser Muster entspricht.Trigger-Events (optional) — Die Pull-Request-Ereignisse, die eine Überprüfung auslösen: Pull Request bereit zur Überprüfung oder Pull Request entworfen. Lass dieses Feld leer, um alle zutreffenden Ereignisse abzugleichen.
Innerhalb einer Filtergruppe müssen alle Bedingungen erfüllt sein (UND). Sie können mehrere Filtergruppen hinzufügen. Eine Überprüfung wird ausgelöst, wenn eine Gruppe zutrifft (ODER).
So konfigurieren Sie Triggerfilter:
Öffnen Sie den Abschnitt Erweiterte Einstellungen im Verbindungsablauf. (Um die Filter für eine bestehende Verbindung zu ändern, wählen Sie die Verbindung im Abschnitt Pipeline aus, wählen Sie Bearbeiten und öffnen Sie dann Erweiterte Einstellungen.)
Suchen Sie das Repository, das Sie konfigurieren möchten, und wählen Sie den Tab Überprüfung ändern aus.
Wähle Filtergruppe hinzufügen und definiere dann die Bedingungen der Gruppe:
Geben Sie unter Zielzweige einen Namen oder ein Muster für den Zweig ein und drücken Sie die Eingabetaste oder wählen Sie Hinzufügen. Wiederholen Sie den Vorgang, um weitere Muster hinzuzufügen.
(Optional) Wähle unter Trigger-Ereignisse die Option Pull Request ready for review, Pull Request drafted oder beides aus. Lassen Sie das Feld leer, um alle Ereignisse abzugleichen.
(Optional) Wählen Sie erneut Filtergruppe hinzufügen, um alternative Bedingungen auszudrücken.
Wählen Sie Speichern, um Ihre Konfiguration zu übernehmen.
Sie können bis zu 5 Filtergruppen pro Repository mit bis zu 20 Mustern pro Gruppe definieren. Jedes Muster muss ein gültiger regulärer Ausdruck mit bis zu 256 Zeichen sein. Wenn Sie keine Filtergruppen hinzufügen, werden Bewertungen bei allen zutreffenden Ereignissen für alle Zielbranchen ausgelöst.
Die GitHub App verstehen
Die AWS DevOps GitHub Agenten-App:
Fordert Zugriff auf Ihre Repositorys an — Sie können die spezifischen Berechtigungen bei der Installation der GitHub App überprüfen
Empfängt Bereitstellungsereignisse und andere Repository-Ereignisse
Ermöglicht es dem AWS DevOps Agenten, Codeänderungen mit Betriebsvorfällen zu korrelieren
Kann jederzeit über Ihre GitHub Einstellungen deinstalliert werden
Für GitHub Enterprise Server und GitHub Enterprise Cloud mit Datenresidenz erstellt der AWS DevOps Agent die GitHub App bei der Registrierung automatisch auf Ihrer Instanz. Sie können den Repository-Zugriff der App verwalten oder sie über Einstellungen > Anwendungen > Installierte GitHub Apps deinstallieren. Um die App-Definition vollständig zu löschen, gehen Sie zu Einstellungen > Entwicklereinstellungen > GitHub Apps.
GitHub Aktualisierungen der App-Berechtigungen
AWS DevOps Der Agent kann nach der Installation der GitHub App Aktualisierungen der Berechtigungen anfordern, um neue Funktionen zu unterstützen. Wenn das passiert:
Sie erhalten eine Benachrichtigung von GitHub bezüglich der Anfrage zur Aktualisierung der Genehmigung.
Lesen Sie die Aktualisierungsdetails, um zu erfahren, welche neuen Berechtigungen angefordert werden.
Wählen Sie Neue Berechtigungen akzeptieren, um die aktualisierten Berechtigungen zu erteilen.
An Ihrem Dienst oder Ihrer Anwendung sind keine Änderungen erforderlich. Nachdem Sie die aktualisierten Berechtigungen akzeptiert haben, enthält das nächste Zugriffstoken für die Installation, das der AWS DevOps Agent anfordert, GitHub automatisch die neuen Berechtigungen.
Anmerkung
Bis Sie eine Aktualisierung der Berechtigungen akzeptieren, arbeitet der AWS DevOps Agent weiterhin mit den zuvor erteilten Berechtigungen. Neue Funktionen, die von den aktualisierten Berechtigungen abhängen, sind erst verfügbar, wenn Sie die Anfrage genehmigen. Die App behält ihre aktuellen Berechtigungen bei, wenn Sie die neuen Berechtigungen nicht akzeptieren.
Angeforderte Berechtigungen
In der folgenden Tabelle werden alle Berechtigungen beschrieben, die die AWS DevOps GitHub Agent-App anfordert, und warum sie benötigt werden.
Wenn Sie bei der Registrierung nur Lesen ausgewählt haben, fordert die GitHub App für jede Berechtigung in der folgenden Tabelle nur Lesezugriff an. Mit Leseberechtigungen kann die GitHub App keine Aktionen auf Schreibebene ausführen, die in der Spalte Zweck aufgeführt sind.
| Berechtigung | Zugriffsebene | Zweck |
|---|---|---|
| Schecks | Lesen und schreiben | Poste die Ergebnisse der Überprüfung des Release-Readiness Codes, während die Prüfung von Pull-Requests ausgeführt wird, sodass der Review-Status direkt in der GitHub Benutzeroberfläche angezeigt wird. |
| Arbeitsabläufe | Lesen und schreiben | Lesen Sie Workflow-Definitionen und lösen Sie GitHub Aktionsworkflows für Releasetests in Ihren CI/CD Pipelines aus. |
| Aktionen | Lesen und schreiben | Überwachen Sie die Workflow-Ausführungen von GitHub Aktionen und greifen Sie bei Vorfalluntersuchungen und Versionstests auf Ausführungsprotokolle zu. |
| Inhalt | Lesen und schreiben | Lesen Sie den Repository-Quellcode für die Codeüberprüfungsanalyse und die Zuordnung von Abhängigkeiten. Der Schreibzugriff ermöglicht es dem Agenten, Lösungen für identifizierte Probleme vorzuschlagen. |
| Pull-Anforderungen | Lesen und schreiben | Lesen Sie Pull-Request-Details, um automatische Code-Reviews auszulösen. Der Schreibzugriff ermöglicht das Posten von Inline-Review-Kommentaren mit Ergebnissen und empfohlenen Korrekturen. |
| Verwaltung der Organisation | Lesen | Lesen Sie die Liste der in der Zielorganisation installierten Anwendungen, um sicherzustellen, dass die AWS DevOps GitHub Agent-App installiert ist. |
GitHub Verbindungen verwalten
Repository-Zugriff aktualisieren — Um zu ändern, auf welche Repositorys die GitHub App zugreifen kann, gehe zu deinen GitHub Konto- oder Organisationseinstellungen. Gehen Sie für GitHub Enterprise Server oder GitHub Enterprise Cloud mit Datenresidenz zu Ihren Instanzeinstellungen. Navigieren Sie dann zu den installierten GitHub Apps und ändern Sie die Konfiguration der AWS DevOps Agent-App.
Verbundene Repositorys anzeigen — Wählen Sie in der AWS DevOps Agentenkonsole Ihren Agentenbereich aus und wechseln Sie zur Registerkarte Funktionen, um die verbundenen Repositorys im Abschnitt Pipeline anzuzeigen.
Ein persönliches Zugriffstoken ersetzen — Sie können das Token einer vorhandenen GitHub Registrierung nicht aktualisieren. Um ein Token zu ersetzen, melden Sie die Registrierung auf der Seite „Capability Providers“ ab. Registrieren Sie sich dann GitHub erneut mit dem neuen Token und verbinden Sie die Repositorys erneut mit Ihren Agent Spaces. Widerrufen Sie das alte Token in Ihren GitHub Einstellungen.
GitHub Verbindung entfernen — Um die Verbindung zu einem Agentenbereich zu GitHub trennen, wählen Sie die Verbindung im Abschnitt Pipeline aus und klicken Sie dann auf Entfernen. Um die GitHub Registrierung von Ihrem Konto zu entfernen, navigieren Sie zur Seite „Capability Providers“, suchen Sie im GitHub Abschnitt nach Ihrer Registrierung und wählen Sie Abmelden.
Gehen Sie wie folgt vor, um die GitHub Integration vollständig zu entfernen:
Gehen Sie zu Ihren GitHub Konto- oder Organisationseinstellungen, um die GitHub App zu deinstallieren.
Um die Verbindung wiederherzustellen, registrieren Sie sich erneut GitHub in der AWS DevOps Agentenkonsole.
Für GitHub Enterprise Server und GitHub Enterprise Cloud mit Datenresidenz erstellt der AWS DevOps Agent die GitHub App während der Registrierung auf Ihrer Instance. Gehen Sie wie folgt vor, um die App vollständig zu bereinigen:
Deinstalliere die App — Gehe zu Einstellungen > Anwendungen > Installierte GitHub Apps, wähle in der App „Konfigurieren“ und deinstalliere sie dann.
App löschen — Gehe zu „Einstellungen“ > „Entwicklereinstellungen“ > „ GitHub Apps“, wähle die App aus, gehe zum Tab „Erweitert“ und wähle „ GitHub App löschen“. Warnung: Das Löschen der GitHub App ist dauerhaft und kann nicht rückgängig gemacht werden. Um eine neue App zu erstellen, registrieren Sie sich erneut GitHub in der AWS DevOps Agent-Konsole.
