Konfiguration für Benachrichtigungen automatisieren

Sie können Cloud Build so konfigurieren, dass Sie Build-Benachrichtigungen an Slack, Google Chat, einen SMTP-Server, einen HTTP-Endpunkt oder eine BigQuery-Instanz senden, indem Sie Cloud Build-Notifier verwenden. Auf dieser Seite wird erläutert, wie Sie den Konfigurationsprozess für den gewünschten Notifier automatisieren können.

Benachrichtigungskonfiguration automatisieren

Cloud Build bietet ein Einrichtungsskript, mit dem Sie die Benachrichtigungskonfiguration automatisieren können. So konfigurieren Sie Benachrichtigungen mit dem Einrichtungsskript:

Slack

Einrichten

In den folgenden Abschnitten werden die Schritte beschrieben, die Sie ausführen müssen, bevor Sie die Benachrichtigungskonfiguration für Ihren Notifier automatisieren.

APIs werden aktiviert

Enable the Cloud Build, Compute Engine, Cloud Run, Pub/Sub, and Secret Manager APIs.

Enable the APIs

Anmeldedaten abrufen und speichern

  1. Erstellen Sie eine Slack-Anwendung für den Slack-Arbeitsbereich, an den Sie Benachrichtigungen senden möchten.

  2. Aktivieren Sie eingehende Webhooks, um Nachrichten von Cloud Build in Slack zu posten.

  3. Gehen Sie zur Slack-Anwendung, um die URL für den eingehenden Webhook zu finden. Die URL sieht in etwa so aus:

    http://hooks.slack.com/services/...

  4. Speichern Sie Ihre eingehende Webhook-URL im Secret Manager:

    1. Öffnen Sie die Seite „Secret Manager“ in der Google Cloud -Console:

      Zur Seite "Secret Manager"

    2. Klicken Sie auf Secret erstellen.

    3. Geben Sie einen Namen für das Secret ein.

    4. Fügen Sie unter Secret-Wert Ihre eingehende Webhook-URL für Ihre Slack-Anwendung hinzu.

    5. Klicken Sie zum Speichern Ihres Secrets auf Secret erstellen.

Notifier-Konfigurationsdatei schreiben

Schreiben Sie eine Konfigurationsdatei, um Ihren Slack-Notifier zu konfigurieren und nach Build-Ereignissen zu filtern:

In der folgenden Konfigurationsdatei für Notifier wird im Feld filter die Option Common Expression Language mit der verfügbaren Variable build verwendet, um Build-Ereignisse mit dem Status SUCCESS zu filtern:

  apiVersion: cloud-build-notifiers/v1
  kind: SlackNotifier
  metadata:
    name: example-slack-notifier
  spec:
    notification:
      filter: build.status == Build.Status.SUCCESS
      delivery:
        webhookUrl:
          secretRef: webhook-url
      template:
        type: golang
        uri: gs://example-gcs-bucket/slack.json
    secrets:
    - name: webhook-url
      value: projects/project-id/secrets/secret-name/versions/latest

Hierbei gilt:

  • webhook-url ist die Konfigurationsvariable, die in diesem Beispiel verwendet wird, um auf den Slack-Webhook-URL-Pfad zu verweisen, der in Secret Manager gespeichert ist. Der hier angegebene Variablenname sollte dem Feld name unter secrets entsprechen.
  • project-id ist die ID Ihres Google Cloud -Projekts.
  • secret-name ist der Name Ihres Secrets, das Ihre Slack-Webhook-URL enthält.
  • Das Feld uri verweist auf die Datei slack.json. Diese Datei enthält eine JSON-Vorlage, die in Cloud Storage gehostet wird und die Benachrichtigungsnachricht für Ihren Slack-Bereich darstellt.

Das Beispiel finden Sie in der entsprechenden Notifier-Konfigurationsdatei für den Slack-Notifier.

Automatisierungsskript ausführen

So automatisieren Sie die Benachrichtigungskonfiguration für Ihren Notifier:

  1. Klonen Sie das Repository für Cloud-Build-Notifier.

  2. Konfigurieren Sie die Google Cloud CLI mit Ihrer Projekt-ID und Region: 

    gcloud config set project project-id
gcloud config set run/region region

    Wobei:

    • project-id ist die Projekt-ID Ihres Google Cloud -Kontos.
    • region ist die Region, in der der Benachrichtigungsdienst bereitgestellt werden soll.

  3. Führen Sie den folgenden Befehl im Stammverzeichnis des Repositorys aus:

    ./setup.sh slack config-path -t template-path -s secret-name

Hierbei gilt:

  • config-path ist der Pfad zu Ihrer Konfigurationsdatei für den Notifier.
  • template-path ist der Pfad zur Vorlagendatei des Notifiers. Die Vorlagendatei für Benachrichtigungen enthält die JSON-Vorlage, die in Cloud Storage gehostet wird, und stellt Ihre Benachrichtigung dar. Sie können die Vorlagendatei des Notifiers mithilfe dieser Variablen oder im Feld uri der Konfigurationsdatei des Notifiers als Pfad angeben.

  • secret-name ist der Name des im Secret Manager gespeicherten Secrets.

Nach der Ausführung des Skripts wird folgende Meldung angezeigt:

** NOTIFIER SETUP COMPLETE **

Ihr Notifier ist jetzt eingerichtet. Sie können sich das vollständige Skript im Repository für Cloud-Build-Notifier ansehen oder ./setup.sh --help ausführen, um eine mit dem Skript verknüpfte Nutzungsanleitung zu erhalten.

Intra-domain Email

Einrichten

In den folgenden Abschnitten werden die Schritte beschrieben, die Sie ausführen müssen, bevor Sie die Benachrichtigungskonfiguration für Ihren Notifier automatisieren.

APIs werden aktiviert

Enable the Cloud Build, Compute Engine, Cloud Run, Pub/Sub, and Secret Manager APIs.

Enable the APIs

Anmeldedaten speichern

  1. Speichern Sie das Passwort für das E-Mail-Konto des Absenders in Secret Manager:

  2. Öffnen Sie die Seite „Secret Manager“ in der Google Cloud -Console:

    Zur Seite "Secret Manager"

  3. Klicken Sie auf Secret erstellen.

  4. Geben Sie einen Namen für das Secret ein.

  5. Fügen Sie unter Secret-Wert das E-Mail-Konto-Passwort des Absenders hinzu.

  6. Klicken Sie zum Speichern Ihres Secrets auf Secret erstellen.

Notifier-Konfigurationsdatei schreiben

Schreiben Sie eine Notifier-Konfigurationsdatei, um Ihren SMTP-Notifier zu konfigurieren und nach Build-Ereignissen zu filtern:

In der folgenden Konfigurationsdatei für Notifier wird im Feld filter die Option Common Expression Language mit der verfügbaren Variable build verwendet, um Build-Ereignisse mit dem Status SUCCESS zu filtern:

 apiVersion: cloud-build-notifiers/v1
 kind: SMTPNotifier
 metadata:
   name: example-smtp-notifier
 spec:
   notification:
     filter: build.status == Build.Status.SUCCESS
     delivery:
       server: server-host-name
       port: "port"
       sender: sender-email
       from: from-email
       recipients:
         - recipient-email
         # optional: more emails here
       password:
         secretRef: smtp-password
      template:
        type: golang
        uri: gs:example-gcs-bucket/smtp.html
   secrets:
   - name: smtp-password
     value: projects/project-id/secrets/secret-name/versions/latest

Wobei:

  • server-host-name ist die Adresse Ihres SMTP-Servers.
  • port ist der Port, der SMTP-Anfragen verarbeitet. Dieser Wert sollte als String angegeben werden.
  • sender-email ist die E-Mail-Adresse des Absenderkontos, die dem angegebenen server-host-name angezeigt wird.
  • from-email ist die E-Mail-Adresse, die für Empfänger angezeigt wird.
  • recipient-email ist eine Liste mit einer oder mehreren E-Mail-Adressen, um Nachrichten vom Absender zu empfangen.
  • smtp-password ist die Konfigurationsvariable, die in diesem Beispiel verwendet wird, um auf das im Secret Manager gespeicherte E-Mail-Konto-Passwort des Absenders zu verweisen. Der hier angegebene Variablenname sollte dem Feld name unter secrets entsprechen.
  • project-id ist die ID Ihres Google Cloud -Projekts.
  • secret-name ist der Name Ihres Secrets, das das Passwort für das E-Mail-Konto des Absenders enthält.
  • Das Feld uri verweist auf die Datei smtp.html. Diese Datei bezieht sich auf eine HTML-Vorlage, die in Cloud Storage gehostet wird und Ihre Benachrichtigungs-E-Mail darstellt.

Das Beispiel finden Sie in der Konfigurationsdatei für Notifier für die SMTP-Notifier.

Automatisierungsskript ausführen

So automatisieren Sie die Benachrichtigungskonfiguration für Ihren Notifier:

  1. Klonen Sie das Repository für Cloud-Build-Notifier.

  2. Konfigurieren Sie die Google Cloud CLI mit Ihrer Projekt-ID und Region: 

    gcloud config set project project-id
gcloud config set run/region region

    Wobei:

    • project-id ist die Projekt-ID Ihres Google Cloud -Kontos.
    • region ist die Region, in der der Benachrichtigungsdienst bereitgestellt werden soll.

  3. Führen Sie den folgenden Befehl im Stammverzeichnis des Repositorys aus:

    ./setup.sh smtp config-path -t template-path -s secret-name

Hierbei gilt:

  • config-path ist der Pfad zu Ihrer Konfigurationsdatei für den Notifier.
  • template-path ist der Pfad zur Vorlagendatei des Notifiers. Die Vorlagendatei für Benachrichtigungen enthält die JSON-Vorlage, die in Cloud Storage gehostet wird, und stellt Ihre Benachrichtigung dar. Sie können die Vorlagendatei des Notifiers mithilfe dieser Variablen oder im Feld uri der Konfigurationsdatei des Notifiers als Pfad angeben.

  • secret-name ist der Name des im Secret Manager gespeicherten Secrets.

Nach der Ausführung des Skripts wird folgende Meldung angezeigt:

** NOTIFIER SETUP COMPLETE **

Ihr Notifier ist jetzt eingerichtet. Sie können sich das vollständige Skript im Repository für Cloud-Build-Notifier ansehen oder ./setup.sh --help ausführen, um eine mit dem Skript verknüpfte Nutzungsanleitung zu erhalten.

BigQuery

Einrichten

In den folgenden Abschnitten werden die Schritte beschrieben, die Sie ausführen müssen, bevor Sie die Benachrichtigungskonfiguration für Ihren Notifier automatisieren.

APIs werden aktiviert

Enable the Cloud Build, Cloud Run, Pub/Sub, and BigQuery APIs.

Enable the APIs

Berechtigungen gewähren

Gewähren Sie Ihrem Cloud Run-Dienstkonto die Berechtigung zum Erstellen und Schreiben von BigQuery-Tabellen und zum Abrufen von Artifact Registry-Daten für Ihren Build:

  1. Rufen Sie in der Google Cloud -Konsole die IAM-Seite auf:

    Seite "IAM" öffnen

  2. Suchen Sie das Compute Engine-Standarddienstkonto, das mit Ihrem Projekt verknüpft ist:

    Ihr Compute Engine-Standarddienstkonto sieht in etwa so aus, wobei project-number Ihre Projektnummer ist:

        project-number-compute@developer.gserviceaccount.com

  3. Klicken Sie auf das Stiftsymbol in der Zeile, die das Compute Engine-Standarddienstkonto enthält.

    Der Tab Zugriff bearbeiten wird angezeigt.

    1. Klicken Sie auf Weitere Rolle hinzufügen.

    2. Fügen Sie die folgenden Rollen hinzu:

      • Artifact Registry-Leser

      • BigQuery-Dateneditor

        Mit der Rolle Artifact Registry-Leser können Sie Daten für Ihre Images abrufen. Mit der Rolle BigQuery-Dateneditor erhalten Sie Lese- und Schreibzugriff auf Ihre Daten.

    3. Klicken Sie auf Speichern.

Notifier-Konfigurationsdatei schreiben

Schreiben Sie eine Notifier-Konfigurationsdatei, um Ihren BigQuery-Notifier zu konfigurieren und nach Build-Ereignissen zu filtern:

In der folgenden Beispiel-Notifier-Konfigurationsdatei verwendet das Feld filter die Common Expression Language mit der Variable build, um Build-Ereignisse mit einer angegebenen Trigger-ID zu filtern:

 apiVersion: cloud-build-notifiers/v1
 kind: BigQueryNotifier
 metadata:
   name: example-bigquery-notifier
 spec:
   notification:
     filter: build.build_trigger_id == "123e4567-e89b-12d3-a456-426614174000"
     delivery:
       table: projects/project-id/datasets/dataset-name/tables/table-name
     template:
       type: golang
       uri: gs://example-gcs-bucket/bq.json

Wobei:

  • project-id ist die ID Ihres Google Cloud -Projekts.
  • dataset-name ist der Name, den Sie dem Dataset geben möchten.
  • table-name ist der Name, den Sie der Tabelle geben möchten.

Das table-name in Ihrer Notifier-Konfigurationsdatei kann auf folgende Elemente verweisen:

  • Eine nicht vorhandene Tabelle
  • Eine leere Tabelle ohne Schema

  • Eine vorhandene Tabelle mit einem Schema, das den Schemaspezifikationen in dem BigQuery-Notifier entspricht

  • Das Feld uri verweist auf die Datei bq.json. Diese Datei bezieht sich auf eine JSON-Vorlage, die in Cloud Storage gehostet wird, und enthält die Informationen, die in Ihre BigQuery-Tabelle eingefügt werden sollen.

Das Beispiel finden Sie in der Konfigurationsdatei für Notifier für den BigQuery-Notifier.

Automatisierungsskript ausführen

So automatisieren Sie die Benachrichtigungskonfiguration für Ihren Notifier:

  1. Klonen Sie das Repository für Cloud-Build-Notifier.

  2. Konfigurieren Sie die Google Cloud CLI mit Ihrer Projekt-ID und Region: 

    gcloud config set project project-id
gcloud config set run/region region

    Wobei:

    • project-id ist die Projekt-ID Ihres Google Cloud -Kontos.
    • region ist die Region, in der der Benachrichtigungsdienst bereitgestellt werden soll.

  3. Führen Sie den folgenden Befehl im Stammverzeichnis des Repositorys aus:

     ./setup.sh bigquery -t config-path -t template-path

    Hierbei gilt:

    • config-path ist der Pfad zu Ihrer Konfigurationsdatei für den Notifier.
    • template-path ist der Pfad zur Vorlagendatei des Notifiers. Die Vorlagendatei für Benachrichtigungen enthält die JSON-Vorlage, die in Cloud Storage gehostet wird, und stellt Ihre Benachrichtigung dar. Sie können die Vorlagendatei des Notifiers mithilfe dieser Variablen oder im Feld uri der Konfigurationsdatei des Notifiers als Pfad angeben.

    Nach der Ausführung des Skripts wird folgende Meldung angezeigt:

    ** NOTIFIER SETUP COMPLETE **

    Ihr Notifier ist jetzt eingerichtet. Sie können sich das vollständige Skript im Repository für Cloud-Build-Notifier ansehen oder ./setup.sh --help ausführen, um eine mit dem Skript verknüpfte Nutzungsanleitung zu erhalten.

HTTP

Einrichten

In den folgenden Abschnitten werden die Schritte beschrieben, die Sie ausführen müssen, bevor Sie die Benachrichtigungskonfiguration für Ihren Notifier automatisieren.

APIs werden aktiviert

Enable the Cloud Build, Cloud Run, and Pub/Sub APIs.

Enable the APIs

Notifier-Konfigurationsdatei schreiben

Schreiben Sie eine Konfigurationsdatei, um Ihren HTTP-Notifier zu konfigurieren und Build-Ereignisse zu filtern:

In der folgenden Konfigurationsdatei für Notifier wird im Feld filter die Option Common Expression Language mit der verfügbaren Variable build verwendet, um Build-Ereignisse mit dem Status SUCCESS zu filtern:

    apiVersion: cloud-build-notifiers/v1
    kind: HTTPNotifier
    metadata:
      name: example-http-notifier
    spec:
      notification:
        filter: build.status == Build.Status.SUCCESS
        delivery:
          # The `http(s)://` protocol prefix is required.
          url: url
        template:
          type: golang
          uri: gs://example-gcs-bucket/http.json

Wobei:

  • url ist die Konfigurationsvariable, die in diesem Beispiel verwendet wird, um die URL für Ihre Anfrage anzugeben.
  • url ist die URL, die Sie als Empfängerserver angeben möchten.
  • Das Feld uri verweist auf die Datei http.json. Diese Datei bezieht sich auf eine JSON-Vorlage, die in Cloud Storage gehostet wird, und stellt die JSON-Nutzlast für den Webhook-Endpunkt dar.

Das Beispiel finden Sie in der entsprechenden Konfigurationsdatei für den HTTP-Notifier.

Automatisierungsskript ausführen

So automatisieren Sie die Benachrichtigungskonfiguration für Ihren Notifier:

  1. Klonen Sie das Repository für Cloud-Build-Notifier.

  2. Konfigurieren Sie die Google Cloud CLI mit Ihrer Projekt-ID und Region: 

    gcloud config set project project-id
gcloud config set run/region region

    Wobei:

    • project-id ist die Projekt-ID Ihres Google Cloud -Kontos.
    • region ist die Region, in der der Benachrichtigungsdienst bereitgestellt werden soll.

  3. Führen Sie den folgenden Befehl im Stammverzeichnis des Repositorys aus:

     ./setup.sh http -t config-path

    Hierbei gilt:

    • config-path ist der Pfad zu Ihrer Konfigurationsdatei für den Notifier.

Nach der Ausführung des Skripts wird folgende Meldung angezeigt:

** NOTIFIER SETUP COMPLETE **

Ihr Notifier ist jetzt eingerichtet. Sie können sich das vollständige Skript im Repository für Cloud-Build-Notifier ansehen oder ./setup.sh --help ausführen, um eine mit dem Skript verknüpfte Nutzungsanleitung zu erhalten.

Google Chat

Einrichten

In den folgenden Abschnitten werden die Schritte beschrieben, die Sie ausführen müssen, bevor Sie die Benachrichtigungskonfiguration für Ihren Notifier automatisieren.

APIs werden aktiviert

Enable the Cloud Build, Compute Engine, Cloud Run, Pub/Sub, and Secret Manager APIs.

Enable the APIs

Anmeldedaten abrufen und speichern

  1. Erstellen Sie einen Gruppenbereich in Google Chat.

  2. Erstellen Sie im erstellten Gruppenbereich einen eingehenden Webhook, um Nachrichten von Cloud Build in Google Chat zu posten. Die URL sieht in etwa so aus:

    https://chat.googleapis.com/v1/spaces/...

  3. Speichern Sie Ihre eingehende Webhook-URL im Secret Manager:

    1. Öffnen Sie die Seite „Secret Manager“ in der Google Cloud -Console:

      Zur Seite "Secret Manager"

    2. Klicken Sie auf Secret erstellen.

    3. Geben Sie einen Namen für das Secret ein.

    4. Fügen Sie unter Secret-Wert Ihre eingehende Webhook-URL für Ihren Google Chat-Bereich hinzu.

    5. Klicken Sie zum Speichern Ihres Secrets auf Secret erstellen.

Notifier-Konfigurationsdatei schreiben

Schreiben Sie eine Konfigurationsdatei, um Ihren Google Chat-Notifier zu konfigurieren und nach Build-Ereignissen zu filtern:

In der folgenden Konfigurationsdatei für Notifier wird im Feld filter die Option Common Expression Language mit der verfügbaren Variable build verwendet, um Build-Ereignisse mit dem Status SUCCESS zu filtern:

  apiVersion: cloud-build-notifiers/v1
  kind: GoogleChatNotifier
  metadata:
    name: example-googlechat-notifier
  spec:
    notification:
      filter: build.status == Build.Status.SUCCESS
      delivery:
        webhookUrl:
          secretRef: webhook-url
    secrets:
    - name: webhook-url
      value: projects/project-id/secrets/secret-name/versions/latest

Wobei:

  • webhook-url ist die Konfigurationsvariable, die in diesem Beispiel verwendet wird, um auf den Google Chat-Webhook-URL-Pfad zu verweisen, der in Secret Manager gespeichert ist. Der hier angegebene Variablenname sollte dem Feld name unter secrets entsprechen.
  • project-id ist die ID Ihres Google Cloud -Projekts.
  • secret-name ist der Name Ihres Secrets, das Ihre Google Chat-Webhook-URL enthält.

Das Beispiel finden Sie in der entsprechenden Konfigurationsdatei für den Google Chat-Notifier.

Automatisierungsskript ausführen

So automatisieren Sie die Benachrichtigungskonfiguration für Ihren Notifier:

  1. Klonen Sie das Repository für Cloud-Build-Notifier.

  2. Konfigurieren Sie die Google Cloud CLI mit Ihrer Projekt-ID und Region: 

    gcloud config set project project-id
gcloud config set run/region region

    Wobei:

    • project-id ist die Projekt-ID Ihres Google Cloud -Kontos.
    • region ist die Region, in der der Benachrichtigungsdienst bereitgestellt werden soll.

  3. Führen Sie den folgenden Befehl im Stammverzeichnis des Repositorys aus:

./setup.sh googlechat config-path -s secret-name

Hierbei gilt:

  • config-path ist der Pfad zu Ihrer Konfigurationsdatei für den Notifier.
  • secret-name ist der Name des im Secret Manager gespeicherten Secrets.

Nach der Ausführung des Skripts wird folgende Meldung angezeigt:

** NOTIFIER SETUP COMPLETE **

Ihr Notifier ist jetzt eingerichtet. Sie können sich das vollständige Skript im Repository für Cloud-Build-Notifier ansehen oder ./setup.sh --help ausführen, um eine mit dem Skript verknüpfte Nutzungsanleitung zu erhalten.

GitHub-Probleme

Einrichten

In den folgenden Abschnitten werden die Schritte beschrieben, die Sie ausführen müssen, bevor Sie die Benachrichtigungskonfiguration für Ihren Notifier automatisieren.

APIs werden aktiviert

Enable the Cloud Build, Compute Engine, Cloud Run, Pub/Sub, and Secret Manager APIs.

Enable the APIs

Anmeldedaten abrufen und speichern

  1. So erstellen Sie ein persönliches GitHub-Zugriffstoken:

    1. Rufen Sie die GitHub-Einstellungen auf, um ein neues Token zu erstellen.

    2. Wählen Sie den Bereich repo aus.

    3. Klicken Sie auf Token generieren.

  2. Speichern Sie das Token in Secret Manager:

    1. Öffnen Sie die Seite „Secret Manager“ in der Google Cloud -Console:

      Zur Seite "Secret Manager"

    2. Klicken Sie auf Secret erstellen.

    3. Geben Sie einen Namen für das Secret ein.

    4. Fügen Sie unter Secret-Wert Ihr GitHub-Token hinzu.

    5. Klicken Sie zum Speichern Ihres Secrets auf Secret erstellen.

Vorlagen-Konfigurationsdatei schreiben

Erstellen Sie eine Vorlagenkonfigurationsdatei, um das Format zu beschreiben, das erstellte GitHub-Probleme haben sollten:

In der folgenden Beispielvorlagenkonfigurationsdatei werden in den Feldern title und body Substitutionsvariablen aus dem Build verwendet: 

{
    "title": "Build {{.Build.BuildTriggerId}}: {{.Build.Status}}",
    "body": "[{{.Build.ProjectId}}] {{.Build.BuildTriggerId}} status: **{{.Build.Status}}**\n\n[View Logs]({{.Build.LogUrl}})"
}

Das Beispiel finden Sie in der Konfigurationsdatei der Vorlage für den GitHub-Issues-Notifier.

Zusätzliche Felder können über die verfügbaren Body-Parameter des GitHub API-Endpunkt zum Erstellen eines Problems festgelegt werden.

Notifier-Konfigurationsdatei schreiben

Schreiben Sie eine Konfigurationsdatei, um Ihren Google Chat-Notifier zu konfigurieren und nach Build-Ereignissen zu filtern:

In der folgenden Konfigurationsdatei für Notifier wird im Feld filter die Option Common Expression Language mit der verfügbaren Variable build verwendet, um Build-Ereignisse mit dem Status SUCCESS zu filtern:

apiVersion: cloud-build-notifiers/v1
kind: GitHubIssuesNotifier
metadata:
  name: example-githubissues-notifier
spec:
  notification:
    filter: build.status == Build.Status.FAILURE
    template: 
      type: golang
      uri: gs://project-id-notifiers-config/template-file-name
    delivery:
      githubToken:
        secretRef: github-token
      githubRepo: myuser/myrepo
  secrets:
  - name: github-token
    value: projects/project-id/secrets/secret-name/versions/latest

Wobei:

  • githubToken ist die Konfigurationsvariable, die in diesem Beispiel verwendet wird, um auf das in Secret Manager gespeicherte GitHub-Token zu verweisen. Der hier angegebene Variablenname sollte dem Feld name unter secrets entsprechen.
  • project-id-notifiers-config ist der Speicherort, an den Ihre Vorlage hochgeladen wird. Der Bucket wird erstellt, falls er noch nicht vorhanden ist.
  • template-file-name ist der Name Ihrer Vorlagendatei.
  • myuser/myrepo ist der Name des Repos, für das Probleme erstellt werden.
  • project-id ist die ID Ihres Google Cloud -Projekts.
  • secret-name ist der Name Ihres Secrets, das Ihr GitHub-Token enthält.

Das Beispiel finden Sie in der entsprechenden Konfigurationsdatei für den Google Chat-Notifier.

Weitere Felder, nach denen Sie filtern können, finden Sie in der Ressource Build. Weitere Filterbeispiele finden Sie unter CEL zum Filtern von Build-Ereignissen verwenden.

Automatisierungsskript ausführen

So automatisieren Sie die Benachrichtigungskonfiguration für Ihren Notifier:

  1. Klonen Sie das Repository für Cloud-Build-Notifier.

  2. Konfigurieren Sie die Google Cloud CLI mit Ihrer Projekt-ID und Region: 

    gcloud config set project project-id
gcloud config set run/region region

    Wobei:

    • project-id ist die Projekt-ID Ihres Google Cloud -Kontos.
    • region ist die Region, in der der Benachrichtigungsdienst bereitgestellt werden soll.

  3. Führen Sie den folgenden Befehl im Stammverzeichnis des Repositorys aus:

    ./setup.sh githubissues config-path -t template-path -s secret-name

Hierbei gilt:

  • config-path ist der Pfad zu Ihrer Konfigurationsdatei für den Notifier.
  • template-path ist der Pfad zur Vorlagendatei des Notifiers. Die Vorlagendatei für Benachrichtigungen enthält die JSON-Vorlage, die in Cloud Storage gehostet wird, und stellt Ihre Benachrichtigung dar. Sie können die Vorlagendatei des Notifiers mithilfe dieser Variablen oder im Feld uri der Konfigurationsdatei des Notifiers als Pfad angeben.

  • secret-name ist der Name des im Secret Manager gespeicherten Secrets.

Nach der Ausführung des Skripts wird folgende Meldung angezeigt:

** NOTIFIER SETUP COMPLETE **

Ihr Notifier ist jetzt eingerichtet. Sie können sich das vollständige Skript im Repository für Cloud-Build-Notifier ansehen oder ./setup.sh --help ausführen, um eine mit dem Skript verknüpfte Nutzungsanleitung zu erhalten.

Nächste Schritte