Diese Seite wurde von der Cloud Translation API übersetzt.
Switch to English

GitHub-App-Trigger erstellen

Mit GitHub-App-Triggern können Sie automatisch Builds für Git-Push- und Git-Pull-Anfragen auslösen und Ihre Build-Ergebnisse auf GitHub und in der Cloud Console aufrufen. Darüber hinaus unterstützen GitHub-App-Trigger alle Funktionen, die von den vorhandenen GitHub-Triggern unterstützt werden, und verwenden die Cloud Build GitHub-App zur Konfiguration und Authentifizierung bei GitHub.

Auf dieser Seite wird erläutert, wie Sie GitHub-App-Trigger erstellen.

GitHub-App-Trigger erstellen

In diesem Abschnitt wird erläutert, wie Sie die Cloud Build-GitHub-App installieren, um Ihr GitHub-Repository mit Ihrem Cloud-Projekt zu verbinden und anschließend GitHub-App-Trigger zu erstellen.

GitHub-Berechtigungen: Sie benötigen Administratorberechtigungen, um Ihr Repository zu verbinden. Administratorberechtigungen sind nicht erforderlich, um Trigger in einem Repository zu erstellen, das bereits mit Cloud Build verbunden ist. Weitere Informationen zu GitHub-Repository-Berechtigungen finden Sie unter Repository-Berechtigungsebenen für eine Organisation.

Cloud Build-App installieren

So installieren Sie die Cloud Build-App und verbinden das GitHub-Repository mit dem Cloud-Projekt:

  1. Öffnen Sie in der Google Cloud Console die Seite Trigger.

    Seite "Trigger" aufrufen

  2. Wählen Sie in der Projektauswahl in der oberen Leiste Ihr Cloud-Projekt aus.

  3. Klicken Sie auf Repository verbinden.

  4. Wählen Sie GitHub (Cloud Build-GitHub-App) aus, klicken Sie das Kästchen zum Akzeptieren der Nutzungsbedingungen an und klicken Sie dann auf Weiter.

  5. (Optional) Wenn Sie sich noch nicht bei GitHub angemeldet haben, tun Sie dies jetzt.

    Die Seite "Autorisierung" wird eingeblendet. Sie werden darin aufgefordert, die Google Cloud Build-App zum Herstellung einer Verbindung zur Google Cloud Platform zu autorisieren.

    Screenshot der Schaltfläche "Autorisieren"

    Klicken Sie auf Google Cloud Build durch GoogleCloudBuild autorisieren.

  6. Klicken Sie auf Google Cloud Build installieren.

  7. Wählen Sie im Pop-up-Fenster Ihren GitHub-Nutzernamen oder Ihre Organisation aus.

  8. Wählen Sie je nach Ihren geschäftlichen Anforderungen eine der folgenden Optionen aus:

    • Alle Repositories: Aktivieren Sie alle aktuellen und zukünftigen GitHub-Repositories für den Zugriff über die Cloud Build-App.

    • Nur ausgewählte Repositories: Verwenden Sie das Drop-down-Menü Repositories auswählen, um nur bestimmte Repositories für den Zugriff über die Cloud Build-App zu aktivieren. Sie können später weitere Repositories hinzufügen.

  9. Klicken Sie auf Installieren, um die Cloud Build-App zu installieren.

    Das Pop-up-Fenster wird geschlossen und Sie gelangen zurück zur Seite Repository auswählen in der Cloud Console. Auf dieser Seite verbinden Sie die GitHub-Repositories mit dem Cloud-Projekt.

  10. Verbinden Sie auf der Seite Repository auswählen die GitHub-Repositories so mit dem Cloud-Projekt:

    a. Bestätigen Sie, dass das richtige GitHub-Konto ausgewählt wurde. Das GitHub-Konto muss Administratorberechtigungen für die GitHub-Repositories haben, die Sie verbinden möchten.

    b. Klicken Sie das Kästchen neben jedem Ziel-Repository an.

    c. Lesen Sie den Haftungsausschluss und klicken Sie anschließend das Kästchen daneben an, um die Nutzungsbedingungen zu akzeptieren.

    d. Klicken Sie auf Repository verbinden.

    Falls ein oder mehrere Ziel-Repositories nicht aufgeführt werden, klicken Sie auf Repositories auf GitHub bearbeiten, um die vorangegangenen Schritte zu wiederholen und weitere Repositories in der Cloud Build-App zu aktivieren.

  11. (Optional) Um Push-Trigger für die zu verbindenden Repositories zu erstellen, klicken Sie das Kästchen neben jedem Ziel-Repository an. Klicken Sie anschließend auf Push-Trigger erstellen. Andernfalls klicken Sie auf Jetzt überspringen.

    Sie haben nun ein oder mehrere GitHub-Repositories mit Ihrem Cloud-Projekt verbunden. Sie werden zur Seite Trigger in der Cloud Console weitergeleitet.

GitHub-App-Trigger erstellen

So erstellen Sie GitHub-App-Trigger:

  1. Öffnen Sie in der Google Cloud Console die Seite Trigger.

    Seite "Trigger" aufrufen

  2. Wählen Sie oben auf der Seite im Drop-down-Menü zur Projektauswahl Ihr Projekt aus.

  3. Klicken Sie auf Öffnen.

  4. Klicken Sie auf Trigger erstellen.

  5. Geben Sie die folgenden Triggereinstellungen ein:

    • Name: Geben Sie einen Namen für den Trigger ein.

    • Beschreibung (optional): Geben Sie eine Beschreibung für den Trigger ein.

    • Ereignis: Wählen Sie das Repository-Ereignis aus, das den Trigger auslösen soll.

      • Push zu Zweig: Legen Sie den Trigger so fest, dass ein Build für Commits zu einem bestimmten Zweig gestartet wird.

      • Neues Tag mit Push übertragen: Legen Sie den Trigger so fest, dass ein Build für Commits gestartet wird, die ein bestimmtes Tag enthalten.

      • Pull-Anfrage (nur GitHub-App): Legen Sie den Trigger so fest, dass ein Build für Commits zu einer Pull-Anfrage gestartet wird.

    • Quelle: Wählen Sie das Repository und den entsprechenden Zweig oder das entsprechende Tag aus, um es auf Ereignisse zu prüfen.

      • Repository: Wählen Sie aus der Liste der verfügbaren Repositories das gewünschte Repository aus. Informationen zum Verbinden eines neuen Repositories finden Sie unter Zusätzliche Repositories verbinden.

      • Zweig oder Tag: Geben Sie einen regulären Ausdruck mit dem abzugleichenden Zweig- oder Tag-Wert an. Informationen zur zulässigen Syntax für reguläre Ausdrücke finden Sie unter RE2-Syntax.

      • Kommentarsteuerung: Wenn Sie Pull-Anfrage (nur GitHub-App) als Ereignis ausgewählt haben, wählen Sie eine der folgenden Optionen aus, um zu kontrollieren, ob ein Build automatisch vom Trigger ausgeführt wird:

        • Erforderlich, außer für Inhaber und Mitbearbeiter: Wenn eine Pull-Anfrage von einem Repository-Inhaber oder Mitbearbeiter erstellt oder aktualisiert wird, werden Builds automatisch vom Trigger ausgeführt. Wenn ein externer Mitwirkender die Aktion initiiert, werden Builds nur ausgeführt, nachdem ein Inhaber oder Mitbearbeiter /gcbrun zur Pull-Anfrage kommentiert hat.

        • Erforderlich: Wenn eine Pull-Anfrage von einem Mitwirkenden erstellt oder aktualisiert wird, werden Builds erst ausgeführt, nachdem ein Inhaber oder Mitbearbeiter /gcbrun zu der Pull-Anfrage kommentiert hat.

        • Nicht erforderlich: Wenn eine Pull-Anfrage von einem Mitwirkenden erstellt oder aktualisiert wird, werden Builds automatisch durch Trigger ausgeführt.

    • Enthaltene Dateien (optional): Änderungen, die mindestens eine dieser Dateien betreffen, lösen einen Build aus.

    • Ignorierte Dateien (optional): Änderungen, die sich nur auf die ignorierten Dateien beziehen, lösen keinen Build aus.

    • Konfiguration: Wählen Sie die Build-Konfigurationsdatei in Ihrem Remote-Repository aus oder erstellen Sie eine Inline-Build-Konfigurationsdatei für Ihren Build.

      • Typ: Wählen Sie den Konfigurationstyp für den Build aus.
        • Cloud Build-Konfigurationsdatei (YAML oder JSON): Verwenden Sie eine Build-Konfigurationsdatei für Ihre Konfiguration.
        • Dockerfile: Dockerfile für Ihre Konfiguration verwenden.
      • Speicherort: Geben Sie den Standort für Ihre Konfiguration an.

        • Repository Wenn sich die Konfigurationsdatei in Ihrem Remote-Repository befindet, geben Sie den Speicherort IhrerBuild-Konfigurationsdatei oder dieDockerfile Verzeichnis und einen Namen für das resultierende Bild. Wenn Ihre Konfiguration ein Dockerfile ist, können Sie optional eine Zeitüberschreitung für Ihren Build angeben. Wenn Sie das Dockerfile und den Image-Namen angegeben haben, sehen Sie eine Vorschau des docker build-Befehls, den Ihr Build ausführen wird.
        • Inline: Wenn Sie als Konfigurationsoption Cloud Build-Konfigurationsdatei (yaml oder json) ausgewählt haben, können Sie Ihre Build-Konfiguration inline angeben. Klicken Sie auf Open Editor (Editor öffnen), um die Build-Konfigurationsdatei in der Google Cloud Console mithilfe der YAML- oder JSON-Syntax zu schreiben. Klicken Sie auf Fertig, um die Build-Konfiguration zu speichern.

  6. Klicken Sie auf Erstellen, um den Build-Trigger zu speichern.

Informationen zum Erstellen von GitHub-Anwendungstriggern mit gcloud-Befehlen finden Sie in den gcloud-Befehlen zum Erstellen eines Build-Triggers.

Verschiedene Typen von GitHub-basierten Triggern

Wenn sich Ihr Quellcode in GitHub befindet, bietet Cloud Build zwei Möglichkeiten, Builds automatisch aufzurufen. In diesem Abschnitt werden die beiden auf GitHub basierenden Trigger erläutert und deren Funktionen verglichen.

  • GitHub-Trigger: Wenn Sie einen GitHub-Trigger erstellen, wird Ihr GitHub-Repository von Cloud Build in Cloud Source Repositories gespiegelt und dieses gespiegelte Repository für alle Vorgänge verwendet. Sie können mit der Cloud Console GitHub-Trigger erstellen und verwalten.

  • GitHub-App-Trigger: Dieser Triggertyp verwendet die Cloud Build-GitHub-App zur Konfiguration und Authentifizierung bei GitHub. Mit GitHub-App-Triggern können Sie automatisch Builds für Git-Push- und Git-Pull-Anfragen starten und die Build-Ergebnisse auf GitHub und in der Cloud Console aufrufen. Sie können mithilfe der Cloud Console oder der Cloud Build API GitHub-App-Trigger erstellen und verwalten.

In der folgenden Tabelle werden die Funktionen von GitHub-Triggern und GitHub-App-Triggern verglichen:

Option GitHub-Trigger GitHub-App-Trigger
Builds für Push-Anfragen an Quellcode aufrufen Ja Ja
Builds für Pull-Anfragen auslösen Nein Ja
Einen Trigger mit der Cloud Console erstellen Ja Ja
Erstellung von Triggern über die Cloud Build API Nein Ja
Erstellung von Triggern über die Cloud Build-GitHub-App Nein Ja
Anzeige des Build-Status in der Cloud Console Ja Ja
Anzeige des Build-Status auf GitHub Nein Ja

Datenfreigabe

GitHub-App-Trigger senden Daten an die Cloud Build GitHub-Anwendung. Die an die Anwendung gesendeten Daten unterstützen Sie dabei, Trigger nach Namen zu erkennen und Build-Ergebnisse auf GitHub aufzurufen.

Die folgenden Daten werden derzeit von der Google Cloud und der GitHub-App geteilt:

  • Triggername

Wenn Sie Trigger vor August 2020 erstellt haben, ist die Datenfreigabe für Ihr Projekt möglicherweise nicht aktiviert. Sie können die Datenfreigabe für alle GitHub-Anwendungs-Trigger in Ihrem Projekt aktivieren, indem Sie auf dem Tab "Datenfreigabe" in Cloud Build auf Aktivieren klicken.

Wenn für ein GitHub-Repository erforderliche Statusprüfungen aktiviert sind, kann das Aktivieren der Datenfreigabe vorübergehend die Statusprüfungen beeinträchtigen. Sie können die Konfigurationen für die Statusprüfung so anpassen, dass nach dem Triggernamen gesucht wird:

  • Cloud Build-spezifische erforderliche Prüfungen im GitHub-Repository deaktivieren
  • Datenfreigabe in Cloud Build sicher aktivieren
  • Neuen Build in Cloud Build ausführen, der Status in Ihr Repository überträgt
  • Erforderliche Statusprüfungen wieder aktivieren und Triggername auswählen

Nächste Schritte