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 Durch die Integration kann der AWS DevOps Agent bei der Untersuchung von Vorfällen auf Code-Repositorys zugreifen und Bereitstellungsereignisse empfangen. Diese Integration folgt einem zweistufigen Prozess: Registrierung von auf Kontoebene GitHub, gefolgt von der Verbindung bestimmter Repositorys mit einzelnen Agent Spaces.
AWS DevOps Agent unterstützt GitHub.com (SaaS), GitHub Enterprise Cloud mit Datenresidenz (*.ghe.com) und GitHub Enterprise Server-Instanzen (selbst gehostet).
Voraussetzungen
Stellen Sie vor der Verbindung sicher GitHub, dass Sie über Folgendes verfügen:
Zugriff auf die Administratorkonsole des AWS DevOps Agenten
Ein GitHub Benutzerkonto oder eine Organisation mit Administratorrechten
Autorisierung zur Installation von GitHub Apps in Ihrem Konto oder Ihrer Organisation
Für GitHub Enterprise Server benötigen Sie außerdem:
Eine GitHub Enterprise Server-Instanz (Version 3.x oder höher), auf die über HTTPS zugegriffen werden kann
Die HTTPS-URL Ihrer GitHub Enterprise Server-Instanz (zum Beispiel
https://github.example.com)(Optional) Eine private Verbindung, wenn Ihre GitHub Enterprise Server-Instanz nicht öffentlich zugänglich ist
Für GitHub Enterprise Cloud mit Datenresidenz benötigen Sie außerdem:
Eine GitHub Enterprise Cloud-Organisation mit aktivierter Datenresidenz, die auf Ihrer dedizierten Subdomain gehostet wird
*.ghe.comAdministratorberechtigungen der Organisation, einschließlich der Erlaubnis, Apps zu erstellen und zu installieren GitHub
Die HTTPS-URL Ihrer Datenresidenzinstanz (z. B.
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
Wählen Sie GitHubaus der Liste der verfügbaren Anbieter
Wenn es GitHub noch nicht registriert wurde, werden Sie aufgefordert, es zuerst zu registrieren.
Schritt 2: Wählen Sie den Verbindungstyp
Wählen Sie auf dem Bildschirm „ GitHub Konto/Organisation registrieren“ aus, ob Sie sich als Benutzer oder Organisation verbinden möchten:
Benutzer — Ihr persönliches GitHub Konto mit einem Benutzernamen und einem Profil
Organisation — Ein gemeinsames GitHub Konto, über das 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 autorisieren und in dieser Organisation installieren müssen.
Wählen Sie die GitHub App-Berechtigungen für Ihre GitHub App aus. Die Berechtigungsstufe bestimmt, welche Aktionen 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.
Wenn Sie eine Verbindung zu einer GitHub Enterprise Server-Instanz herstellen, wählen Sie GitHub Use 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 Instanz sicher erreichen kann. Weitere Informationen finden Sie unter Verbindung zu privat gehosteten Tools herstellen.
Anmerkung
Fügen /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 GitHub Enterprise verwenden und geben Sie die HTTPS-URL Ihrer Datenresidenzinstanz ein (z. B.). https://octocorp.ghe.com
Schritt 3: 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.
Für GitHub.com
GitHub leitet Sie weiter, sich anzumelden und den AWS DevOps Agenten zu autorisieren.
Überprü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 von Ihnen angegebenen Konto oder der Organisation installiert ist, fahren Sie mit der Installationsseite fort (siehe Schritt 4). 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, den Sie bei der Registrierung angegeben haben. Wenn Sie ein anderes Konto oder eine andere Organisation autorisieren oder dort installieren, 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 mit dieser Berechtigungsstufe autorisiert haben, wird GitHub möglicherweise der Autorisierungsbildschirm übersprungen. 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 4: 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 kann:
Alle Repositorien — Gewähren Sie Zugriff auf alle aktuellen und future Repositorien
Nur Repositorys auswählen — Wählen Sie bestimmte Repositorys aus Ihrem Konto oder Ihrer Organisation aus
Wähle Installieren und autorisieren.
Sie werden zurück zur AWS DevOps Agent-Konsole weitergeleitet, wo GitHub Sie auf Kontoebene als registriert angezeigt werden.
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 GitHubaus 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 herzustellen
Sie können je nach den Anforderungen Ihres Unternehmens 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 von Codeüberprüfung und automatisiertem Testen
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 A auslösen Code-Reviews zur Veröffentlichungsbereitschaft und welche Testfunktionen automatisiert werden.
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. Dieser Abschnitt enthält zwei Einstellungen pro Repository:
Automatische Überprüfung von Änderungen auslösen — Wenn diese Option für ein Repository aktiviert ist, wird der DevOps Agent automatisch Code-Reviews zur Veröffentlichungsbereitschaft jedes Mal ausgeführt, wenn eine Pull-Anfrage geöffnet oder aktualisiert wird. Überprüfungsergebnisse werden als Inline-Kommentare zur Pull-Anfrage angezeigt. Dies ist standardmäßig für alle verbundenen Repositorys aktiviert.
Automatisierte Überprüfungstests — Wenn diese Option für ein Repository aktiviert ist, erstellt, führt der DevOps Agent Ihre Codeänderungen während der Code-Reviews in einer verwalteten Überprüfungsumgebung aus und testet sie. Dies ermöglicht eine funktionale Validierung, die über die statische Analyse hinausgeht. Weitere Informationen finden Sie unter Automatisierte Überprüfungstests. 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 für die Ausführung automatisierter Funktionen auf Ihren ausgewählten Repositorys übernimmt. Diese Rolle wird beim Zugriff auf interne Dienste verwendet, die für Builds benötigt werden, z. B. private Paketregistrierungen und Artefaktspeichersysteme. 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 Änderungen, je nachdem, ob du automatische Pull-Request-Reviews möchtest.
Aktivieren oder deaktivieren Sie für jedes Repository die Funktion Automatisierte Überprüfungstests, je nachdem, ob Sie automatisierte Überprüfungstests in einer verwalteten Überprüfungsumgebung wünschen.
Wählen Sie optional eine IAM-Rolle aus dem Drop-down-Menü „Runtime-Rolle“ aus, die der DevOps Agent bei der Ausführung automatisierter Funktionen auf Ihren ausgewählten Repositorys übernimmt.
Wählen Sie Speichern, um Ihre Konfiguration zu übernehmen.
Nach der Konfiguration löst jeder neue Pull-Request in einem Repository, bei dem die automatische Änderungsprüfung aktiviert ist, automatisch eine Überprüfung des Release-Readiness-Codes aus. Wenn auch automatisierte Überprüfungstests aktiviert sind, umfasst die Überprüfung die funktionale Validierung in einer Überprüfungsumgebung. Weitere Informationen zu Code-Reviews finden Sie unterCode-Reviews zur Veröffentlichungsbereitschaft.
Die GitHub App verstehen
Die AWS DevOps GitHub Agenten-App:
Fordert Zugriff auf Ihre Repositorys an — Sie können die spezifischen Berechtigungen während der Installation der GitHub App überprüfen
Empfängt Bereitstellungsereignisse und andere Repository-Ereignisse
Ermöglicht dem AWS DevOps Agenten, Codeänderungen mit betrieblichen Vorfällen zu korrelieren
Kann jederzeit über Ihre GitHub Einstellungen deinstalliert werden
Bei 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 aus, um die aktualisierten Berechtigungen zu gewähren.
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 ein Berechtigungsupdate 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, 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 Schreibgeschützt ausgewählt haben, fordert die GitHub App für jede Berechtigung in der folgenden Tabelle nur Lesezugriff an. Mit den Berechtigungen „Nur Lesen“ 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 | Die Ergebnisse der Codeüberprüfung nach der Veröffentlichungsreife, wenn die Prüfung auf Pull-Requests ausgeführt wird, sodass der Überprüfungsstatus direkt in der GitHub Benutzeroberfläche angezeigt wird. |
| Arbeitsabläufe | Lesen und schreiben | Lesen Sie Workflow-Definitionen und lösen Sie GitHub Aktions-Workflows 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 der Untersuchung von Vorfällen und beim Testen von Releases auf Ausführungsprotokolle zu. |
| Inhalt | Lesen und schreiben | Lesen Sie den Quellcode des Repositorys für die Code-Review-Analyse 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 die Details der Pull-Anfrage, um automatisierte Code-Reviews auszulösen. Der Schreibzugriff ermöglicht das Posten von Inline-Bewertungskommentaren 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 Agent-Konsole Ihren Agent Space aus und wechseln Sie zur Registerkarte Funktionen, um die verbundenen Repositorys im Abschnitt Pipeline anzuzeigen.
GitHub Verbindung entfernen — Um die Verbindung zu einem Agent Space zu GitHub trennen, wählen Sie die Verbindung im Abschnitt Pipeline und anschließend Entfernen aus. Um die GitHub Registrierung von Ihrem Konto zu entfernen, rufen Sie die Seite Capability Providers auf, suchen Sie im GitHubAbschnitt nach Ihrer Registrierung und wählen Sie Abmelden aus.
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 Instanz. Gehen Sie wie folgt vor, um die App vollständig zu bereinigen:
App deinstallieren — Wähle „Einstellungen“ > „Anwendungen“ > „Installierte GitHub Apps“, wähle in der App „Konfigurieren“ und deinstalliere sie anschließend.
App löschen — Wähle „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 Agentenkonsole.
