View a markdown version of this page

GitHub und GitHub Enterprise Server-Zugriffstoken - AWS CodeBuild

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 und GitHub Enterprise Server-Zugriffstoken

Voraussetzungen für Zugriffstoken

Bevor Sie beginnen, müssen Sie Ihrem GitHub Zugriffstoken die richtigen Berechtigungsbereiche hinzufügen.

Denn GitHub Ihr persönliches Zugriffstoken muss die folgenden Bereiche haben.

  • repo gewährt volle Kontrolle über private Repositorys.

  • repo:status: Gewährt read/write Zugriff auf den Commit-Status eines öffentlichen und privaten Repositorys.

  • admin:repo_hook gewährt volle Kontrolle über Repository-Hooks. Dieser Bereich ist nicht erforderlich, wenn Ihr Token den Bereich repo aufweist.

  • admin:org_hook: Gewährt die volle Kontrolle über Organisations-Hooks. Dieser Bereich ist nur erforderlich, wenn Sie die Webhook-Funktion für Organisationen verwenden.

Weitere Informationen finden Sie auf der Website unter Grundlegendes zu den Bereichen für OAuth-Apps. GitHub

Wenn Sie detaillierte persönliche Zugriffstoken verwenden, benötigt Ihr persönliches Zugriffstoken je nach Anwendungsfall möglicherweise die folgenden Berechtigungen:

  • Inhalt Read-only: Gewährt Zugriff auf private Repositorys. Diese Berechtigung ist erforderlich, wenn Sie private Repositorys als Quelle verwenden.

  • Commit-Status: Lesen und Schreiben: Erteilt die Berechtigung, Commit-Status zu erstellen. Diese Berechtigung ist erforderlich, wenn für Ihr Projekt ein Webhook eingerichtet ist oder Sie die Funktion zum Erstellen von Berichten aktiviert haben.

  • Webhooks: Lesen und Schreiben: Erteilt die Erlaubnis, Webhooks zu verwalten. Diese Erlaubnis ist erforderlich, wenn in Ihrem Projekt ein Webhook eingerichtet ist.

  • Pull-Requests Read-only: Erteilt die Erlaubnis, auf Pull-Requests zuzugreifen. Diese Berechtigung ist erforderlich, wenn dein Webhook einen FILE_PATH Filter für Pull-Request-Ereignisse hat.

  • Administration: Lesen und Schreiben: Diese Berechtigung ist erforderlich, wenn du die selbst gehostete GitHub Actions Runner-Funktion mit verwendest. CodeBuild Weitere Informationen finden Sie unter Registrierungstoken für ein Repository erstellen undTutorial: Konfigurieren Sie einen CodeBuild-hosted GitHub Actions-Runner.

Anmerkung

Wenn Sie auf Organisations-Repositorys zugreifen möchten, stellen Sie sicher, dass Sie die Organisation als Ressourcenbesitzer des Zugriffstokens angeben.

Weitere Informationen findest du unter Erforderliche Berechtigungen für detaillierte persönliche Zugriffstoken auf der Website. GitHub

Stellen Sie eine Verbindung GitHub mit einem Zugriffstoken her (Konsole)

Gehen Sie beim Erstellen eines Projekts wie folgt vor, um GitHub mithilfe eines Zugriffstokens mithilfe der Konsole eine Verbindung zu Ihrem Projekt herzustellen. Weitere Informationen finden Sie unter Erstellen Sie ein Build-Projekt (Konsole).

  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, ob Sie Kontoanmeldeinformationen verwenden möchten, um die Standard-Quelldaten Ihres Kontos auf alle Projekte anzuwenden.

      1. Wenn Sie nicht verbunden sind GitHub, wählen Sie Kontoanmeldeinformationen verwalten aus.

      2. Wählen Sie als Anmeldeinformationstyp Persönliches Zugriffstoken aus.

    • Wenn Sie Anmeldeinformationen auf Kontoebene für den Dienst verwenden möchten, wählen Sie aus, welchen Dienst Sie zum Speichern Ihres Tokens verwenden möchten, und gehen Sie wie folgt vor:

      1. Wenn Sie Secrets Manager verwenden möchten, können Sie wählen, ob Sie eine bestehende geheime Verbindung verwenden oder ein neues Geheimnis erstellen und dann Speichern wählen. Weitere Informationen zum Erstellen eines neuen Geheimnisses finden Sie unterErstelle und speichere ein Token in einem Secrets Manager-Geheimnis.

      2. Wenn Sie sich für die Verwendung entscheiden CodeBuild, geben Sie Ihr GitHub persönliches Zugriffstoken ein und wählen Sie dann Speichern.

    • Wählen Sie Nur für dieses Projekt überschreibende Anmeldedaten verwenden aus, um die Einstellungen für die Anmeldeinformationen Ihres Kontos mithilfe benutzerdefinierter Quellanmeldedaten zu überschreiben.

      1. Wählen Sie aus der Liste der ausgefüllten Anmeldeinformationen eine der Optionen unter Persönliches Zugriffstoken aus.

      2. Sie können auch ein neues persönliches Zugriffstoken erstellen, indem Sie in der Beschreibung die Option Neue persönliche Zugriffstoken-Verbindung erstellen auswählen.

Stellen Sie eine Verbindung GitHub mit einem Zugriffstoken (CLI) her

Folgen Sie diesen Schritten, um das AWS CLI zu verwenden, um Ihr Projekt GitHub mithilfe eines Zugriffstokens zu verbinden. Informationen zur Verwendung von AWS CLI with AWS CodeBuild finden Sie unterBefehlszeilenreferenz.

  1. Führen Sie den Befehl import-source-credentials aus:

    aws codebuild import-source-credentials --generate-cli-skeleton

    JSON-formatted Daten werden in der Ausgabe angezeigt. Kopieren Sie die Daten in eine Datei (z. B.import-source-credentials.json) an einem Speicherort auf dem lokalen Computer oder der Instanz, auf der der installiert AWS CLI ist. Ändern Sie die kopierten Daten wie im Folgenden dargestellt und speichern Sie die Ergebnisse.

    { "serverType": "server-type", "authType": "auth-type", "shouldOverwrite": "should-overwrite", "token": "token", "username": "username" }

    Ersetzen Sie Folgendes:

    • server-type: Erforderlicher Wert. Der Quellanbieter für diese Anmeldeinformationen. Gültige Werte sind GITHUB, BITBUCKET, GITHUB_ENTERPRISE, GITLAB und GITLAB_SELF_MANAGED.

    • auth-type: Erforderlicher Wert. Die Art der Authentifizierung, die für die Verbindung zu einem Repository verwendet wird. Gültige Werte sind OAUTH, BASIC_AUTH, PERSONAL_ACCESS_TOKEN, CODECONNECTIONS und SECRETS_MANAGER. GitHubDenn nur PERSONAL_ACCESS_TOKEN ist zulässig. BASIC_AUTH ist nur mit dem Bitbucket-App-Passwort oder API-Token zulässig.

    • should-overwrite: Optionaler Wert. Setzen Sie diesen auf false, um zu verhindern, dass die Repository-Quellanmeldeinformationen überschrieben werden. Legen Sie den Wert auf true fest, um die Repository-Quellanmeldeinformationen zu überschreiben. Der Standardwert ist true.

    • token: Erforderlicher Wert. Für GitHub unseren GitHub Enterprise Server ist dies das persönliche Zugriffstoken. Für Bitbucket ist dies das persönliche Zugriffstoken, das App-Passwort oder das API-Token. Für den Auth-Typ CODECONNECTIONS ist dies der Verbindungs-ARN. Für den Auth-Typ SECRETS_MANAGER ist dies der geheime ARN.

    • username: Optionaler Wert. Dieser Parameter wird für GitHub und GitHub Enterprise Server-Quellanbieter ignoriert. Für ein Bitbucket-App-Passwort ist das dein Bitbucket-Nutzername. Bei einem Bitbucket-API-Token ist dies die E-Mail-Adresse, die mit deinem Atlassian-Konto verknüpft ist.

  2. Um Ihr Konto mit einem Zugriffstoken zu verbinden, wechseln Sie in das Verzeichnis mit der Datei import-source-credentials.json, die Sie in Schritt 1 gespeichert haben, und führen den Befehl import-source-credentials erneut aus.

    aws codebuild import-source-credentials --cli-input-json file://import-source-credentials.json

    JSON-formatted Daten werden in der Ausgabe mit einem Amazon-Ressourcennamen (ARN) angezeigt.

    { "arn": "arn:aws:codebuild:region:account-id:token/server-type" }
    Anmerkung

    Wenn Sie den Befehl import-source-credentials mit demselben Server- und Auth-Typ ein zweites Mal ausführen, wird das gespeicherte Zugriffstoken aktualisiert.

    Nachdem Ihr Konto mit einem Zugriffstoken verknüpft wurde, können Sie es verwenden, create-project um Ihr CodeBuild Projekt zu erstellen. Weitere Informationen finden Sie unter Erstellen Sie ein Build-Projekt (AWS CLI).

  3. Rufen Sie zum Anzeigen der verbundenen Zugriffstoken den Befehl list-source-credentials auf.

    aws codebuild list-source-credentials

    In der Ausgabe erscheint ein JSON-formatted sourceCredentialsInfos Objekt:

    { "sourceCredentialsInfos": [ { "authType": "auth-type", "serverType": "server-type", "arn": "arn" } ] }

    sourceCredentialsObject enthält eine Liste der verbundenen Quell-Anmeldeinformationen:

    • authType ist der Typ der Authentifizierung für die Anmeldeinformationen. Dies kannOAUTH,BASIC_AUTH, PERSONAL_ACCESS_TOKENCODECONNECTIONS, oder seinSECRETS_MANAGER.

    • serverType ist der Typ des Quellanbieters. Dies kannGITHUB,GITHUB_ENTERPRISE, BITBUCKETGITLAB, oder seinGITLAB_SELF_MANAGED.

    • arn ist der ARN des Tokens.

  4. Rufen Sie den Befehl delete-source-credentials mit dem zugehörigen ARN auf, um einen Quellanbieter zu trennen und dessen Zugriffstoken zu entfernen.

    aws codebuild delete-source-credentials --arn arn-of-your-credentials

    JSON-formatted Daten werden mit einer ARN der gelöschten Anmeldeinformationen zurückgegeben.

    { "arn": "arn:aws:codebuild:region:account-id:token/server-type" }