View a markdown version of this page

GitHub App-Verbindungen für GitHub einen GitHub Enterprise Server - AWS CodeBuild
Schritt 1: Stellen Sie eine Verbindung zur GitHub App (Konsole) herSchritt 2: Gewähren Sie dem CodeBuild Projekt IAM-Rollenzugriff, um die Verbindung verwenden zu könnenSchritt 3: Konfigurieren CodeBuild Sie die neue VerbindungFehlerbehebung bei der GitHub App

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.

GitHub App-Verbindungen für GitHub einen GitHub Enterprise Server

Sie können die GitHub App verwenden, um eine Verbindung herzustellen CodeBuild. GitHub App-Verbindungen werden unterstützt durch AWS CodeConnections.

Der Zugriff auf den Quellanbieter ermöglicht es Ihnen, einen Build auszulösen, indem Sie GitHub Webhook-Ereignisse ihn abonnieren CreateWebhook, verwenden oder verwendenTutorial: Konfigurieren Sie einen CodeBuild-hosted GitHub Actions-Runner. CodeBuild

Anmerkung

CodeConnections ist in weniger Regionen verfügbar als CodeBuild. Sie können regionsübergreifende Verbindungen in CodeBuild verwenden. Verbindungen, die in Opt-in-Regionen erstellt wurden, können in anderen Regionen nicht verwendet werden. Weitere Informationen finden Sie unter AWS CodeConnections -Endpunkte und -Kontingente.

Schritt 1: Stellen Sie eine Verbindung zur GitHub App (Konsole) her

Gehen Sie wie folgt vor, um mithilfe der CodeBuild Konsole eine Verbindung für Ihr Projekt hinzuzufügen GitHub.

Um eine Verbindung herzustellen zu GitHub
Anmerkung

Anstatt eine bestehende Verbindung in Ihrem Konto herzustellen oder zu verwenden, können Sie eine Verbindung verwenden, die von einem anderen AWS Konto aus geteilt wurde. Weitere Informationen findest du unter Verbindungen mit AWS Konten teilen.

Schritt 2: Gewähren Sie dem CodeBuild Projekt IAM-Rollenzugriff, um die Verbindung verwenden zu können

Sie können CodeBuild Projekt-IAM-Rollenzugriff gewähren, um die über Ihre Verbindung GitHub verkauften Token verwenden zu können.

Um CodeBuild Projekt-IAM-Rollenzugriff zu gewähren

  1. Erstellen Sie eine IAM-Rolle für Ihr CodeBuild Projekt, indem Sie den Anweisungen Erlauben CodeBuild Sie die Interaktion mit anderen AWS service für Ihr CodeBuild Projekt folgen.

  2. Folgen Sie den Anweisungen und fügen Sie Ihrer CodeBuild Projektrolle die folgende IAM-Richtlinie hinzu, um Zugriff auf die Verbindung zu gewähren.

    JSON
    {
    "Version":"2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "codeconnections:GetConnectionToken",
                "codeconnections:GetConnection"
            ],
            "Resource": [
                "arn:aws:iam::*:role/Service*"
            ]
        }
    ]
}

Schritt 3: Konfigurieren CodeBuild Sie die neue Verbindung

Sie können eine Verbindung als Anmeldeinformationen auf Kontoebene konfigurieren und in einem Projekt verwenden.

AWS-Managementkonsole
Um eine Verbindung als Anmeldeinformationen auf Kontoebene zu konfigurieren, finden Sie im AWS-Managementkonsole

  1. Wählen Sie für Quellanbieter die Option GitHub.

  2. Führen Sie für Credential einen der folgenden Schritte aus:

    • Wählen Sie Standard-Quell-Anmeldeinformationen, um die Standard-Quell-Anmeldeinformationen Ihres Kontos zu verwenden, die für alle Projekte gelten.

      1. Wenn Sie nicht verbunden sind GitHub, wählen Sie Standard-Quell-Anmeldeinformationen verwalten aus.

      2. Wählen Sie als Anmeldeinformationstyp App aus GitHub .

      3. Wählen Sie unter Verbindung aus, ob Sie eine vorhandene Verbindung verwenden oder eine neue Verbindung erstellen möchten.

    • Wählen Sie Benutzerdefinierte Quellanmeldeinformationen, um benutzerdefinierte Quellanmeldeinformationen zu verwenden, um die Standardeinstellungen Ihres Kontos zu überschreiben.

      1. Wählen Sie als Anmeldeinformationstyp App aus. GitHub

      2. Wählen Sie unter Verbindung aus, ob Sie eine vorhandene Verbindung verwenden oder eine neue Verbindung erstellen möchten.

AWS CLI
Um eine Verbindung als Anmeldeinformationen auf Kontoebene zu konfigurieren, finden Sie im AWS CLI

  • Öffnen Sie die Eingabeaufforderung (Windows) oder das Terminal (Linux, macOS oder Unix). Verwenden Sie den, AWS CLI um den import-source-credentials Befehl auszuführen --auth-type--server-type, und geben Sie dabei --token für Ihre Verbindung an.

    Verwenden Sie den folgenden Befehl:

    aws codebuild import-source-credentials --auth-type CODECONNECTIONS --server-type GITHUB --token <connection-arn>

Sie können auch mehrere Token für Ihre CodeBuild Projekte einrichten. Weitere Informationen finden Sie unter Konfigurieren Sie mehrere Token als Anmeldeinformationen auf Quellenebene.

Behebung von Problemen mit der GitHub App

Die folgenden Informationen können Ihnen bei der Behebung häufig auftretender Probleme mit der GitHub App helfen.

Installieren Sie das AWS Connector für GitHub App in einer unerwünschten Region

Problem: Sie haben den AWS Connector für GitHub aus dem GitHub Marketplace installiert, aber die Verbindung wurde in einer unerwünschten Region hergestellt. Wenn Sie versuchen, die App auf der GitHub Website neu zu konfigurieren, funktioniert dies nicht, da die App bereits in Ihrem GitHub Konto installiert ist.

Mögliche Ursache: Die App ist bereits in Ihrem GitHub Konto installiert, sodass Sie nur die App-Berechtigungen neu konfigurieren können.

Empfohlene Lösung: Sie können eine neue Verbindung mit der Installations-ID in der gewünschten Region herstellen.

  1. Öffnen Sie die CodeConnections Konsole unter https://console.aws.amazon.com/codesuite/settings/connections und navigieren Sie mithilfe der Regionsauswahl in der Navigationsleiste der AWS Konsole zur gewünschten Region.

  2. Folgen Sie den Anweisungen im Benutzerhandbuch für die Entwicklertools zum Erstellen einer Verbindung zu GitHub.

    Anmerkung

    Da Sie den AWS Connector für die GitHub App bereits installiert haben, können Sie ihn auswählen, anstatt eine neue App zu installieren.

Die GitHub App-Verbindung hat keinen Zugriff auf Repositorys

Problem: Ein AWS Dienst, der die Verbindung verwendet, wie z. B. CodeBuild oder CodePipeline, meldet, dass er keinen Zugriff auf das Repository hat oder dass das Repository nicht existiert. Zu den möglichen Fehlermeldungen gehören:

  • Authentication required for primary source.

  • Unable to create webhook at this time. Please try again later.

  • Failed to create webhook. GitHub API limit reached. Please try again later.

Mögliche Ursache: Möglicherweise haben Sie die GitHub App verwendet und den Webhook-Berechtigungsumfang nicht erteilt.

Empfohlene Lösung: Um den erforderlichen Berechtigungsumfang zu gewähren, folgen Sie den Anweisungen unter Navigieren zu der GitHub App, die Sie überprüfen oder ändern möchten, um die installierte App zu konfigurieren. Im Abschnitt „Berechtigungen“ siehst du, dass die App keine Webhooks-Berechtigung hat, und du hast die Möglichkeit, die neu angeforderten Berechtigungen zu überprüfen. Überprüfe und akzeptiere die neuen Berechtigungen. Weitere Informationen findest du unter Aktualisierte Berechtigungen für eine GitHub App https://docs.github.com/en/apps/using-github-apps/approving-updated-permissions-for-a-github-app genehmigen.

Mögliche Ursache: Die Verbindung funktionierte wie erwartet, hat aber plötzlich keinen Zugriff mehr auf die Repositorys.

Mögliche Lösung: Überprüfen Sie zunächst Ihre Autorisierungen und Ihre Installationen und stellen Sie dann sicher, dass die GitHub App autorisiert und installiert ist. Wenn die GitHub App-Installation unterbrochen ist, müssen Sie die Sperrung aufheben. Wenn die GitHub App nicht für eine https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user UAT-Verbindung (User Access Token) autorisiert ist oder nicht für eine https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation IAT-Verbindung (Installation Access Token) installiert ist, kann die bestehende Verbindung nicht mehr verwendet werden und Sie müssen eine neue Verbindung erstellen. Beachten Sie, dass durch die Neuinstallation der GitHub App die vorherige Verbindung, die mit der alten Installation verknüpft war, nicht wiederhergestellt wird.

Mögliche Lösung: Wenn es sich bei der Verbindung um eine UAT-Verbindung handelt, stellen Sie sicher, dass die Verbindung nicht gleichzeitig verwendet wird, z. B. in mehreren CodeBuild gleichzeitigen Build-Läufen. Dies liegt daran, dass eine zuvor ausgestellte UAT GitHub sofort ungültig wird, wenn ein ablaufendes Token durch die Verbindung aktualisiert wird. Wenn Sie die UAT-Verbindung für mehrere gleichzeitige CodeBuild Builds verwenden müssen, können Sie mehrere Verbindungen erstellen und jede Verbindung unabhängig verwenden.

Mögliche Lösung: Wenn die UAT-Verbindung in den letzten 6 Monaten nicht verwendet wurde, wird die Verbindung von ungültig erklärt. GitHub Um dies zu beheben, erstellen Sie eine neue Verbindung.

Mögliche Ursache: Möglicherweise haben Sie eine UAT-Verbindung verwendet, ohne die App zu installieren.

Empfohlene Lösung: Für das Erstellen einer UAT-Verbindung muss die Verbindung zwar nicht mit einer GitHub App-Installation verknüpft werden, es ist jedoch eine Installation erforderlich, damit auf das Repository zugegriffen werden kann. Folgen Sie den Anweisungen, um die Installationen zu überprüfen und sicherzustellen, dass die GitHub App installiert ist. Wenn sie nicht installiert ist, navigieren Sie zur Seite der GitHub App, um die App zu installieren. Weitere Informationen zum Zugriff von UAT finden Sie unter Über Benutzerzugriffstoken.

Das Tool AWS In der IAM-Rolle des Dienstes fehlen die erforderlichen IAM-Berechtigungen.

Problem: Es wird eine der folgenden Fehlermeldungen angezeigt:

  • Access denied to connection <connection-arn>

  • Failed to get access token from <connection-arn>

Empfohlene Lösung: In der Regel verwenden Sie eine Verbindung mit einem AWS Dienst wie CodePipeline oder CodeBuild. Wenn Sie dem AWS Dienst eine IAM-Rolle zuweisen, kann der AWS Dienst die Rechte der Rolle nutzen, um in Ihrem Namen zu handeln. Stellen Sie sicher, dass die IAM-Rolle über die erforderlichen Berechtigungen verfügt. Weitere Informationen zur erforderlichen IAM-Berechtigung finden Sie unter Gewähren des CodeBuild Projekt-IAM-Rollenzugriffs zur Verwendung der Verbindungs - und Identitäts- und Zugriffsverwaltung für AWS CodeStar Benachrichtigungen sowie CodeConnections im Benutzerhandbuch der Developer Tools-Konsole.