View a markdown version of this page

GitHub Verbindungen - AWS CodePipeline

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 Verbindungen

Sie verwenden Verbindungen, um Konfigurationen zu autorisieren und einzurichten, die Ihren Drittanbieter mit Ihren AWS Ressourcen verknüpfen.

Anmerkung

Anstatt eine bestehende Verbindung in Ihrem Konto herzustellen oder zu verwenden, können Sie eine gemeinsame Verbindung zwischen anderen AWS-Konto verwenden. Siehe Verwenden Sie eine Verbindung, die mit einem anderen Konto geteilt wird.

Anmerkung

Diese Funktion ist in den Regionen Asien-Pazifik (Hongkong), Asien-Pazifik (Hyderabad), Asien-Pazifik (Jakarta), Asien-Pazifik (Melbourne), Asien-Pazifik (Osaka), Afrika (Kapstadt), Naher Osten (Bahrain), Naher Osten (VAE), Europa (Spanien), Europa (Zürich), Israel (Tel Aviv) oder AWS GovCloud (US-West) nicht verfügbar. Informationen zu anderen verfügbaren Aktionen finden Sie unter. Produkt- und Serviceintegrationen mit CodePipeline Überlegungen zu dieser Aktion in der Region Europa (Mailand) finden Sie im Hinweis unterCodeStarSourceConnection für Bitbucket Cloud GitHub, GitHub Enterprise Server und GitLab.com GitLab selbstverwaltete Aktionen.

Um eine Quellaktion für Ihr GitHub oder das GitHub Enterprise Cloud-Repository hinzuzufügen CodePipeline, können Sie eine der folgenden Optionen wählen:

  • Verwenden Sie den Assistenten zum Erstellen einer Pipeline in der CodePipeline Konsole oder auf der Aktionsseite „Aktion bearbeiten“, um die Anbieteroption GitHub (über GitHub App) auszuwählen. Weitere Informationen finden Erstellen Sie eine Verbindung zu GitHub (Konsole) Sie unter So fügen Sie die Aktion hinzu. Die Konsole hilft Ihnen beim Erstellen einer Verbindungsressource.

    Anmerkung

    Ein Tutorial, das Ihnen zeigt, wie Sie eine GitHub Verbindung hinzufügen und die Option Vollständiger Klon in Ihrer Pipeline verwenden, um Metadaten zu klonen, finden Sie unterTutorial: Vollständigen Klon mit einer GitHub Pipeline-Quelle verwenden.

  • Verwenden Sie die CLI, um die Aktionskonfiguration für die CodeStarSourceConnection Aktion beim GitHub Anbieter hinzuzufügen. Gehen Sie dazu wie unter beschrieben vorErstellen einer Pipeline (CLI).

Anmerkung

Sie können eine Verbindung auch mithilfe der Developer Tools-Konsole unter Einstellungen herstellen. Siehe Verbindung erstellen.

Bevor Sie beginnen:

  • Sie müssen ein Konto bei erstellt haben GitHub.

  • Sie müssen bereits ein GitHub Code-Repository erstellt haben.

  • Wenn Ihre CodePipeline Servicerolle vor dem 18. Dezember 2019 erstellt wurde, müssen Sie möglicherweise ihre Berechtigungen aktualisieren, um sie codestar-connections:UseConnection für AWS CodeStar Verbindungen verwenden zu können. Detaillierte Anweisungen finden Sie unter Fügen Sie der CodePipeline Servicerolle Berechtigungen hinzu.

Anmerkung

Um die Verbindung herzustellen, müssen Sie der Eigentümer der GitHub Organisation sein. Bei Repositorys, die keiner Organisation angehören, müssen Sie der Repository-Besitzer sein.

Erstellen Sie eine Verbindung zu GitHub (Konsole)

Gehen Sie wie folgt vor, um mithilfe der CodePipeline Konsole eine Verbindungsaktion für Ihr Repository GitHub oder das GitHub Enterprise Cloud-Repository hinzuzufügen.

Anmerkung

In diesen Schritten können Sie bestimmte Repositorys unter Repository-Zugriff auswählen. Alle Repositorys, die nicht ausgewählt sind, sind für sie nicht zugänglich und auch nicht sichtbar. CodePipeline

Schritt 1: Erstellen oder bearbeiten Sie Ihre Pipeline

  1. Melden Sie sich bei der CodePipeline Konsole an.

  2. Wählen Sie eine der folgenden Optionen aus.

    • Wählen Sie, ob Sie eine Pipeline erstellen möchten. Folgen Sie den Schritten unter Pipeline erstellen, um den ersten Bildschirm auszufüllen, und wählen Sie Weiter. Wählen Sie auf der Quellseite unter Quellanbieter die Option GitHub (über GitHub App) aus.

    • Wählen Sie, ob Sie eine vorhandene Pipeline bearbeiten möchten. Wählen Sie „Bearbeiten“ und dann „Phase bearbeiten“. Wählen Sie, ob Sie Ihre Quellaktion hinzufügen oder bearbeiten möchten. Geben Sie auf der Seite Aktion bearbeiten unter Aktionsname den Namen für Ihre Aktion ein. Wählen Sie unter Aktionsanbieter die Option GitHub (über GitHub App) aus.

  3. Führen Sie eine der folgenden Aktionen aus:

    • Wählen Sie unter Verbindung die Option Verbinden mit aus, falls Sie noch keine Verbindung zu Ihrem Anbieter hergestellt haben GitHub. Fahren Sie mit Schritt 2 fort: Erstellen Sie eine Verbindung zu GitHub.

    • Wenn Sie bereits eine Verbindung zu Ihrem Anbieter hergestellt haben, wählen Sie unter Verbindung die Verbindung aus. Fahren Sie mit Schritt 3: Speichern Sie die Quellaktion für Ihre Verbindung fort.

Schritt 2: Erstellen Sie eine Verbindung zu GitHub

Nachdem Sie sich entschieden haben, die Verbindung herzustellen, wird die GitHub Seite Verbinden mit angezeigt.

Screenshot der Konsole, der die erste GitHub Verbindungsseite zeigt.
Um eine Verbindung herzustellen zu GitHub
  1. Unter GitHub Verbindungseinstellungen wird Ihr Verbindungsname im Feld Verbindungsname angezeigt. Wählen Sie Verbinden mit GitHub. Die Seite für die Zugriffsanforderung wird angezeigt.

  2. Wählen Sie AWS Connector autorisieren für GitHub. Die Verbindungsseite wird angezeigt und zeigt das Feld GitHub Apps.

    Screenshot der Konsole, der die erste GitHub Verbindungsseite mit dem Feld GitHub Apps zeigt.
  3. Wählen Sie unter GitHub Apps eine App-Installation aus oder wählen Sie Neue App installieren, um eine zu erstellen.

    Sie installieren eine App für alle Verbindungen mit einem bestimmten Anbieter. Wenn Sie den AWS Connector für die GitHub App bereits installiert haben, wählen Sie ihn aus und überspringen Sie diesen Schritt.

    Anmerkung

    Wenn Sie ein Benutzerzugriffstoken erstellen möchten, stellen Sie sicher, dass Sie den AWS Connector für die GitHub App bereits installiert haben, und lassen Sie dann das Feld für die App-Installation leer. CodeConnections verwendet das Benutzerzugriffstoken für die Verbindung.

  4. Wählen Sie auf der GitHub Seite AWS Connector installieren für das Konto aus, auf dem Sie die App installieren möchten.

    Anmerkung

    Sie installieren die App nur einmal für jedes GitHub Konto. Wenn Sie die App schon einmal installiert haben, können Sie Configure (Konfiguration) wählen und mit einer Änderungsseite für die App-Installation fortfahren. Alternativ kommen Sie über die Schaltfläche „Back“ (Zurück) zur Konsole zurück.

  5. Belassen Sie auf der GitHub Seite „ AWS Connector installieren für“ die Standardeinstellungen und wählen Sie „Installieren“.

  6. Auf der GitHub Seite „Verbinden mit“ wird die Verbindungs-ID für Ihre neue Installation unter GitHub Apps angezeigt. Wählen Sie Connect aus.

Schritt 3: Speichern Sie Ihre GitHub Quellaktion

Gehen Sie auf der Seite „Aktion bearbeiten“ wie folgt vor, um Ihre Quellaktion mit Ihren Verbindungsinformationen zu speichern.

Um Ihre GitHub Quellaktion zu speichern
  1. Wählen Sie unter Repository name (Repository-Name) den Namen Ihres Drittanbieter-Repositorys aus.

  2. Unter Pipeline-Trigger können Sie Auslöser hinzufügen, wenn es sich bei Ihrer Aktion um eine CodeConnections Aktion handelt. Weitere Informationen zur Konfiguration der Pipeline-Trigger und zum optionalen Filtern nach Triggern finden Sie unterTrigger mit Code-Push- oder Pull-Request-Ereignistypen hinzufügen.

  3. Im Output artifact format (Format des Ausgabeartefakts) müssen Sie das Format für Ihre Artefakte auswählen.

  4. Wählen Sie im Assistenten Weiter oder auf der Aktionsseite „Bearbeiten“ die Option Speichern.

Stellen Sie eine Verbindung zu GitHub (CLI) her

Sie können die AWS Command Line Interface (AWS CLI) verwenden, um eine Verbindung herzustellen.

Verwenden Sie dazu den Befehl create-connection.

Wichtig

Eine Verbindung, die über AWS CLI oder AWS CloudFormation erstellt wurde, hat standardmäßig PENDING den Status. Nachdem Sie eine Verbindung mit der CLI oder hergestellt haben CloudFormation, bearbeiten Sie die Verbindung mithilfe der Konsole, um ihren Status zu ermittelnAVAILABLE.

So stellen Sie eine Verbindung her
  1. Öffnen Sie die Eingabeaufforderung (Windows) oder das Terminal (Linux, macOS oder Unix). Verwenden Sie den AWS CLI , um den create-connection Befehl auszuführen, und geben Sie dabei das --provider-type und --connection-name für Ihre Verbindung an. In diesem Beispiel lautet der Name des Drittanbieters GitHub und der angegebene Verbindungsname MyConnection.

    aws codestar-connections create-connection --provider-type GitHub --connection-name MyConnection

    Wenn der Befehl erfolgreich ausgeführt wurde, gibt er die ARN-Informationen der Verbindung ähnlich der folgenden zurück.

    { "ConnectionArn": "arn:aws:codestar-connections:us-west-2:account_id:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f" }
  2. Verwenden Sie die Konsole, um die Verbindung fertigzustellen. Weitere Informationen finden Sie unter Aktualisieren einer ausstehenden Verbindung.

  3. Die Pipeline erkennt standardmäßig Änderungen, wenn Code an das Verbindungsquellen-Repository übertragen wird. Gehen Sie wie folgt vor, um die Pipeline-Trigger-Konfiguration für die manuelle Freigabe oder für Git-Tags zu konfigurieren:

    • Um die Pipeline-Trigger-Konfiguration so zu konfigurieren, dass sie nur mit einer manuellen Version beginnt, fügen Sie der Konfiguration die folgende Zeile hinzu:

      "DetectChanges": "false",
    • Weitere Informationen zur Konfiguration der Pipeline-Trigger-Konfiguration zum Filtern nach Triggern finden Sie unterTrigger mit Code-Push- oder Pull-Request-Ereignistypen hinzufügen. Das Folgende erweitert beispielsweise die Pipeline-Ebene der Pipeline-JSON-Definition. In diesem Beispiel release-v1 sind release-v0 und die einzuschließenden Git-Tags und release-v2 das auszuschließende Git-Tag.

      "triggers": [ { "providerType": "CodeStarSourceConnection", "gitConfiguration": { "sourceActionName": "Source", "push": [ { "tags": { "includes": [ "release-v0", "release-v1" ], "excludes": [ "release-v2" ] } } ] } } ]