Automatizzazione della configurazione per le notifiche

Puoi configurare Cloud Build in modo che ti invii notifiche di build a Slack, Google Chat, un server SMTP, un endpoint HTTP o un'istanza BigQuery utilizzando gli strumenti di notifica di Cloud Build. Questa pagina spiega come automatizzare il processo di configurazione per il notifier che preferisci.

Automazione della configurazione delle notifiche

Cloud Build fornisce uno script di configurazione che puoi utilizzare per automatizzare la configurazione delle notifiche. Per configurare le notifiche utilizzando lo script di configurazione:

Slack

Configurazione

Le sezioni seguenti descrivono i passaggi da completare prima di automatizzare la configurazione delle notifiche per il tuo sistema di notifica.

Abilitazione delle API in corso…

Abilita le API Cloud Build, Compute Engine, Cloud Run, Pub/Sub e Secret Manager, se non sono già abilitate.

Ruoli richiesti per abilitare le API

Per abilitare le API, devi disporre dell'autorizzazione serviceusage.services.enable. Se hai creato il progetto, probabilmente hai già questa autorizzazione tramite il ruolo Proprietario (roles/owner). In caso contrario, puoi ottenere questa autorizzazione tramite il ruolo Amministratore Service Usage (roles/serviceusage.serviceUsageAdmin). Scopri come concedere i ruoli.

Abilita le API

Ottenere e archiviare le credenziali

  1. Crea un'app Slack per l'area di lavoro Slack a cui vuoi inviare notifiche.

  2. Attiva i webhook in entrata per pubblicare messaggi da Cloud Build su Slack.

  3. Vai alla tua app Slack per individuare l'URL del webhook in entrata. L'URL sarà simile al seguente:

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

  4. Archivia l'URL webhook in entrata in Secret Manager:

    1. Apri la pagina Secret Manager nella console Google Cloud :

      Apri la pagina Secret Manager

    2. Fai clic su Crea secret.

    3. Inserisci un nome per il secret.

    4. In Valore secret, aggiungi l'URL webhook in entrata per la tua app Slack.

    5. Per salvare il secret, fai clic su Crea secret.

Scrittura di un file di configurazione del notifier

Scrivi un file di configurazione per configurare il tuo sistema di notifica Slack e filtrare gli eventi di build:

Nel seguente file di configurazione di esempio del sistema di notifica, il campo filter utilizza il Common Expression Language con la variabile disponibile, build, per filtrare gli eventi di build con uno stato SUCCESS:

  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://bucket-name/slack.json
    secrets:
    - name: webhook-url
      value: projects/project-id/secrets/secret-name/versions/latest

Dove:

  • webhook-url è la variabile di configurazione utilizzata in questo esempio per fare riferimento al percorso dell'URL webhook di Slack archiviato in Secret Manager. Il nome della variabile specificato qui deve corrispondere al campo name in secrets.
  • bucket-name è il nome del bucket Cloud Storage in cui lo script di configurazione carica il file del template. Se il bucket non esiste, lo script di configurazione lo crea nel tuo progetto e verifica la proprietà del bucket prima di caricare i file.
  • project-id è l'ID del tuo progetto Google Cloud .
  • secret-name è il nome del secret che contiene l'URL webhook di Slack.
  • Il campo uri fa riferimento al file slack.json. Questo file contiene un template JSON ospitato su Cloud Storage e rappresenta il messaggio di notifica per il tuo spazio Slack.

Per visualizzare l'esempio, consulta il file di configurazione di notifica per l'agente di notifica Slack.

Esecuzione dello script di automazione

Per automatizzare la configurazione delle notifiche per il tuo sistema di notifica:

  1. Clona il repository cloud-build-notifiers.

  2. Configura Google Cloud CLI con l'ID progetto e la regione: 

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

    Dove:

    • project-id è l'ID progetto Google Cloud .
    • region è la regione in cui eseguire il deployment del sistema di notifica.

  3. Esegui questo comando nella directory principale del repository:

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

Dove:

  • config-path è il percorso del file di configurazione degli strumenti di notifica.
  • bucket-name è il nome del bucket Cloud Storage in cui lo script di configurazione carica i file di configurazione e di template. Se ometti -b, lo script genera un nome bucket con un suffisso casuale (notifiers-config-random-suffix).
  • template-path è il percorso del file del template dei notificatori. Il file del template degli strumenti di notifica contiene il template JSON ospitato su Cloud Storage e rappresenta il messaggio di notifica. Puoi includere il file del template dei tuoi notificatori come percorso utilizzando questa variabile o all'interno del campo uri del file di configurazione dei notificatori.

  • secret-name è il nome del secret archiviato in Secret Manager.

Dopo aver eseguito lo script, vedrai il seguente messaggio:

** NOTIFIER SETUP COMPLETE **

Il tuo notifier è ora configurato. Puoi visualizzare lo script completo nel repository cloud-build-notifiers o eseguire ./setup.sh --help per istruzioni sull'utilizzo associate allo script.

SMTP

Configurazione

Le sezioni seguenti descrivono i passaggi da completare prima di automatizzare la configurazione delle notifiche per il tuo sistema di notifica.

Abilitazione delle API in corso…

Abilita le API Cloud Build, Compute Engine, Cloud Run, Pub/Sub e Secret Manager, se non sono già abilitate.

Ruoli richiesti per abilitare le API

Per abilitare le API, devi disporre dell'autorizzazione serviceusage.services.enable. Se hai creato il progetto, probabilmente hai già questa autorizzazione tramite il ruolo Proprietario (roles/owner). In caso contrario, puoi ottenere questa autorizzazione tramite il ruolo Amministratore Service Usage (roles/serviceusage.serviceUsageAdmin). Scopri come concedere i ruoli.

Abilita le API

Archiviazione delle credenziali

  1. Archivia la password dell'account email del mittente in Secret Manager:

  2. Apri la pagina Secret Manager nella console Google Cloud :

    Apri la pagina Secret Manager

  3. Fai clic su Crea secret.

  4. Inserisci un nome per il secret.

  5. In Valore secret, aggiungi la password dell'account email del mittente.

  6. Per salvare il secret, fai clic su Crea secret.

Scrittura di un file di configurazione del notifier

Scrivi un file di configurazione del sistema di notifica per configurare il sistema di notifica SMTP e filtrare gli eventi di build:

Nel seguente file di configurazione di esempio del sistema di notifica, il campo filter utilizza il Common Expression Language con la variabile disponibile, build, per filtrare gli eventi di build con uno stato SUCCESS:

 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://bucket-name/smtp.html
   secrets:
   - name: smtp-password
     value: projects/project-id/secrets/secret-name/versions/latest

Dove:

  • server-host-name è l'indirizzo del tuo server SMTP.
  • port è la porta che gestirà le richieste SMTP. Questo valore deve essere specificato come stringa.
  • sender-email è l'indirizzo email dell'account mittente visualizzato dall'utente server-host-name specificato.
  • from-email è l'indirizzo email visualizzato dai destinatari.
  • recipient-email è un elenco di uno o più indirizzi email che riceveranno i messaggi dal mittente.
  • smtp-password è la variabile di configurazione utilizzata in questo esempio per fare riferimento alla password dell'account email del mittente archiviata in Secret Manager. Il nome della variabile specificato qui deve corrispondere al campo name in secrets.
  • project-id è l'ID del tuo progetto Google Cloud .
  • secret-name è il nome del secret che contiene la password dell'account email del mittente.
  • bucket-name è il nome del bucket Cloud Storage in cui lo script di configurazione carica il file del template. Se il bucket non esiste, lo script di configurazione lo crea nel tuo progetto e verifica la proprietà del bucket prima di caricare i file.
  • Il campo uri fa riferimento al file smtp.html. Questo file fa riferimento a un modello HTML ospitato su Cloud Storage e rappresenta l'email di notifica.

Per visualizzare l'esempio, consulta il file di configurazione di notifica per l'agente di notifica SMTP.

Esecuzione dello script di automazione

Per automatizzare la configurazione delle notifiche per il tuo sistema di notifica:

  1. Clona il repository cloud-build-notifiers.

  2. Configura Google Cloud CLI con l'ID progetto e la regione: 

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

    Dove:

    • project-id è l'ID progetto Google Cloud .
    • region è la regione in cui eseguire il deployment del sistema di notifica.

  3. Esegui questo comando nella directory principale del repository:

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

Dove:

  • config-path è il percorso del file di configurazione degli strumenti di notifica.
  • bucket-name è il nome del bucket Cloud Storage in cui lo script di configurazione carica i file di configurazione e di template. Se ometti -b, lo script genera un nome bucket con un suffisso casuale (notifiers-config-random-suffix).
  • template-path è il percorso del file del template dei notificatori. Il file del template degli strumenti di notifica contiene il template JSON ospitato su Cloud Storage e rappresenta il messaggio di notifica. Puoi includere il file del template dei tuoi notificatori come percorso utilizzando questa variabile o all'interno del campo uri del file di configurazione dei notificatori.

  • secret-name è il nome del secret archiviato in Secret Manager.

Dopo aver eseguito lo script, vedrai il seguente messaggio:

** NOTIFIER SETUP COMPLETE **

Il tuo notifier è ora configurato. Puoi visualizzare lo script completo nel repository cloud-build-notifiers o eseguire ./setup.sh --help per istruzioni sull'utilizzo associate allo script.

BigQuery

Configurazione

Le sezioni seguenti descrivono i passaggi da completare prima di automatizzare la configurazione delle notifiche per il tuo sistema di notifica.

Abilitazione delle API in corso…

Abilita le API Cloud Build, Cloud Run, Pub/Sub e BigQuery, se non sono già abilitate.

Ruoli richiesti per abilitare le API

Per abilitare le API, devi disporre dell'autorizzazione serviceusage.services.enable. Se hai creato il progetto, probabilmente hai già questa autorizzazione tramite il ruolo Proprietario (roles/owner). In caso contrario, puoi ottenere questa autorizzazione tramite il ruolo Amministratore Service Usage (roles/serviceusage.serviceUsageAdmin). Scopri come concedere i ruoli.

Abilita le API

Concessione di autorizzazioni

Concedi al account di servizio Cloud Run l'autorizzazione per creare e scrivere tabelle BigQuery e l'autorizzazione per recuperare i dati di Artifact Registry relativi alla tua build:

  1. Vai alla pagina IAM nella console Google Cloud :

    Apri la pagina IAM

  2. Individua il service account predefinito di Compute Engine associato al tuo progetto:

    Il tuo service account predefinito di Compute Engine sarà simile al seguente, dove project-number è il numero del tuo progetto:

        project-number-compute@developer.gserviceaccount.com

  3. Fai clic sull'icona a forma di matita nella riga contenente il tuo service account predefinito di Compute Engine.

    Verrà visualizzata la scheda Accesso in modifica.

    1. Fai clic su Aggiungi un altro ruolo.

    2. Aggiungi i seguenti ruoli:

      • Artifact Registry Reader

      • BigQuery Data Editor

        Il ruolo Lettore Artifact Registry ti consente di recuperare i dati per le tue immagini. Il ruolo BigQuery Data Editor ti consente di accedere in lettura e scrittura ai tuoi dati.

    3. Fai clic su Salva.

Scrittura di un file di configurazione del notifier

Scrivi un file di configurazione del notifier per configurare il notifier BigQuery e filtrare gli eventi di build:

Nel seguente file di configurazione di esempio per l'agente di notifica, il campo filter utilizza il Common Expression Language con la variabile build per filtrare gli eventi di build con un ID trigger specificato:

 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://bucket-name/bq.json

Dove:

  • project-id è l'ID del tuo progetto Google Cloud .
  • dataset-name è il nome che vuoi assegnare al set di dati.
  • table-name è il nome che vuoi assegnare alla tabella.
  • bucket-name è il nome del bucket Cloud Storage in cui lo script di configurazione carica il file del template. Se il bucket non esiste, lo script di configurazione lo crea nel tuo progetto e verifica la proprietà del bucket prima di caricare i file.
  • Il campo uri fa riferimento al file bq.json. Questo file fa riferimento a un template JSON ospitato su Cloud Storage e rappresenta le informazioni da inserire nella tabella BigQuery.

Il campo table-name nel file di configurazione del notifier può fare riferimento a:

  • una tabella inesistente
  • una tabella vuota senza schema

  • una tabella esistente con uno schema che corrisponde alle specifiche dello schema nel notifier di BigQuery

Per visualizzare l'esempio, consulta il file di configurazione di notifica per l'agente di notifica di BigQuery.

Esecuzione dello script di automazione

Per automatizzare la configurazione delle notifiche per il tuo sistema di notifica:

  1. Clona il repository cloud-build-notifiers.

  2. Configura Google Cloud CLI con l'ID progetto e la regione: 

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

    Dove:

    • project-id è l'ID progetto Google Cloud .
    • region è la regione in cui eseguire il deployment del sistema di notifica.

  3. Esegui questo comando nella directory principale del repository:

     ./setup.sh bigquery config-path -b bucket-name -t template-path

    Dove:

    • config-path è il percorso del file di configurazione degli strumenti di notifica.
    • bucket-name è il nome del bucket Cloud Storage in cui lo script di configurazione carica i file di configurazione e di template. Se ometti -b, lo script genera un nome bucket con un suffisso casuale (notifiers-config-random-suffix).
    • template-path è il percorso del file del template dei notificatori. Il file del template degli strumenti di notifica contiene il template JSON ospitato su Cloud Storage e rappresenta il messaggio di notifica. Puoi includere il file del template dei tuoi notificatori come percorso utilizzando questa variabile o all'interno del campo uri del file di configurazione dei notificatori.

    Dopo aver eseguito lo script, vedrai il seguente messaggio:

    ** NOTIFIER SETUP COMPLETE **

    Il tuo notifier è ora configurato. Puoi visualizzare lo script completo nel repository cloud-build-notifiers o eseguire ./setup.sh --help per istruzioni sull'utilizzo associate allo script.

HTTP

Configurazione

Le sezioni seguenti descrivono i passaggi da completare prima di automatizzare la configurazione delle notifiche per il tuo sistema di notifica.

Abilitazione delle API in corso…

Abilita le API Cloud Build, Cloud Run e Pub/Sub, se non sono già abilitate.

Ruoli richiesti per abilitare le API

Per abilitare le API, devi disporre dell'autorizzazione serviceusage.services.enable. Se hai creato il progetto, probabilmente hai già questa autorizzazione tramite il ruolo Proprietario (roles/owner). In caso contrario, puoi ottenere questa autorizzazione tramite il ruolo Amministratore Service Usage (roles/serviceusage.serviceUsageAdmin). Scopri come concedere i ruoli.

Abilita le API

Scrittura di un file di configurazione del notifier

Scrivi un file di configurazione del notifier per configurare il notifier HTTP e filtrare gli eventi di build:

Nel seguente file di configurazione di esempio del sistema di notifica, il campo filter utilizza il Common Expression Language con la variabile disponibile, build, per filtrare gli eventi di build con uno stato SUCCESS:

    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://bucket-name/http.json

Dove:

  • url è la variabile di configurazione utilizzata in questo esempio per specificare l'URL della richiesta.
  • url è l'URL che vuoi specificare come server destinatario.
  • bucket-name è il nome del bucket Cloud Storage in cui lo script di configurazione carica il file del template. Se il bucket non esiste, lo script di configurazione lo crea nel tuo progetto e verifica la proprietà del bucket prima di caricare i file.
  • Il campo uri fa riferimento al file http.json. Questo file fa riferimento a un template JSON ospitato su Cloud Storage e rappresenta il payload JSON per l'endpoint del webhook.

Per visualizzare l'esempio, consulta il file di configurazione del notifier per il notifier HTTP.

Esecuzione dello script di automazione

Per automatizzare la configurazione delle notifiche per il tuo sistema di notifica:

  1. Clona il repository cloud-build-notifiers.

  2. Configura Google Cloud CLI con l'ID progetto e la regione: 

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

    Dove:

    • project-id è l'ID progetto Google Cloud .
    • region è la regione in cui eseguire il deployment del sistema di notifica.

  3. Esegui questo comando nella directory principale del repository:

     ./setup.sh http config-path -b bucket-name

    Dove:

    • config-path è il percorso del file di configurazione degli strumenti di notifica.
    • bucket-name è il nome del bucket Cloud Storage in cui lo script di configurazione carica il file di configurazione. Se ometti -b, lo script genera un nome bucket con un suffisso casuale (notifiers-config-random-suffix).

Dopo aver eseguito lo script, vedrai il seguente messaggio:

** NOTIFIER SETUP COMPLETE **

Il tuo notifier è ora configurato. Puoi visualizzare lo script completo nel repository cloud-build-notifiers o eseguire ./setup.sh --help per istruzioni sull'utilizzo associate allo script.

Google Chat

Configurazione

Le sezioni seguenti descrivono i passaggi da completare prima di automatizzare la configurazione delle notifiche per il tuo sistema di notifica.

Abilitazione delle API in corso…

Abilita le API Cloud Build, Compute Engine, Cloud Run, Pub/Sub e Secret Manager, se non sono già abilitate.

Ruoli richiesti per abilitare le API

Per abilitare le API, devi disporre dell'autorizzazione serviceusage.services.enable. Se hai creato il progetto, probabilmente hai già questa autorizzazione tramite il ruolo Proprietario (roles/owner). In caso contrario, puoi ottenere questa autorizzazione tramite il ruolo Amministratore Service Usage (roles/serviceusage.serviceUsageAdmin). Scopri come concedere i ruoli.

Abilita le API

Ottenere e archiviare le credenziali

  1. Crea uno spazio in Google Chat.

  2. All'interno dello spazio creato, crea un webhook in entrata per pubblicare messaggi da Cloud Build a Google Chat. L'URL sarà simile al seguente:

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

  3. Archivia l'URL webhook in entrata in Secret Manager:

    1. Apri la pagina Secret Manager nella console Google Cloud :

      Apri la pagina Secret Manager

    2. Fai clic su Crea secret.

    3. Inserisci un nome per il secret.

    4. In Valore secret, aggiungi l'URL webhook in entrata per lo spazio di Google Chat.

    5. Per salvare il secret, fai clic su Crea secret.

Scrittura di un file di configurazione del notifier

Scrivi un file di configurazione per configurare l'utilità di notifica di Google Chat e filtrare gli eventi di build:

Nel seguente file di configurazione di esempio del sistema di notifica, il campo filter utilizza il Common Expression Language con la variabile disponibile, build, per filtrare gli eventi di build con uno stato SUCCESS:

  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

Dove:

  • webhook-url è la variabile di configurazione utilizzata in questo esempio per fare riferimento al percorso dell'URL webhook di Google Chat archiviato in Secret Manager. Il nome della variabile specificato qui deve corrispondere al campo name in secrets.
  • project-id è l'ID del tuo progetto Google Cloud .
  • secret-name è il nome del secret che contiene l'URL webhook di Google Chat.

Per visualizzare l'esempio, consulta il file di configurazione del sistema di notifica per Google Chat.

Esecuzione dello script di automazione

Per automatizzare la configurazione delle notifiche per il tuo sistema di notifica:

  1. Clona il repository cloud-build-notifiers.

  2. Configura Google Cloud CLI con l'ID progetto e la regione: 

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

    Dove:

    • project-id è l'ID progetto Google Cloud .
    • region è la regione in cui eseguire il deployment del sistema di notifica.

  3. Esegui questo comando nella directory principale del repository:

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

Dove:

  • config-path è il percorso del file di configurazione degli strumenti di notifica.
  • bucket-name è il nome del bucket Cloud Storage in cui lo script di configurazione carica il file di configurazione. Se ometti -b, lo script genera un nome bucket con un suffisso casuale (notifiers-config-random-suffix).
  • secret-name è il nome del secret archiviato in Secret Manager.

Dopo aver eseguito lo script, vedrai il seguente messaggio:

** NOTIFIER SETUP COMPLETE **

Il tuo notifier è ora configurato. Puoi visualizzare lo script completo nel repository cloud-build-notifiers o eseguire ./setup.sh --help per istruzioni sull'utilizzo associate allo script.

GitHub Issues

Configurazione

Le sezioni seguenti descrivono i passaggi da completare prima di automatizzare la configurazione delle notifiche per il tuo sistema di notifica.

Abilitazione delle API in corso…

Abilita le API Cloud Build, Compute Engine, Cloud Run, Pub/Sub e Secret Manager, se non sono già abilitate.

Ruoli richiesti per abilitare le API

Per abilitare le API, devi disporre dell'autorizzazione serviceusage.services.enable. Se hai creato il progetto, probabilmente hai già questa autorizzazione tramite il ruolo Proprietario (roles/owner). In caso contrario, puoi ottenere questa autorizzazione tramite il ruolo Amministratore Service Usage (roles/serviceusage.serviceUsageAdmin). Scopri come concedere i ruoli.

Abilita le API

Ottenere e archiviare le credenziali

  1. Crea un token di accesso personale GitHub:

    1. Vai alle impostazioni di GitHub per creare un nuovo token.

    2. Seleziona l'ambito repo.

    3. Fai clic su Genera token.

  2. Archivia il token in Secret Manager:

    1. Apri la pagina Secret Manager nella console Google Cloud :

      Apri la pagina Secret Manager

    2. Fai clic su Crea secret.

    3. Inserisci un nome per il secret.

    4. In Valore secret, aggiungi il tuo token GitHub.

    5. Per salvare il secret, fai clic su Crea secret.

Scrittura di un file di configurazione del template

Scrivi un file di configurazione del modello per descrivere il formato che devono assumere i problemi GitHub creati:

Nel seguente file di configurazione del modello di esempio, i campi title e body utilizzano variabili di sostituzione della build: 

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

Per visualizzare l'esempio, consulta il file di configurazione del modello per l'agente di notifica dei problemi di GitHub.

È possibile impostare campi aggiuntivi dai parametri del corpo disponibili dall'endpoint API GitHub per la creazione di un problema.

Scrittura di un file di configurazione del notifier

Scrivi un file di configurazione per configurare l'utilità di notifica di Google Chat e filtrare gli eventi di build:

Nel seguente file di configurazione di esempio del sistema di notifica, il campo filter utilizza il Common Expression Language con la variabile disponibile, build, per filtrare gli eventi di build con uno stato SUCCESS:

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://bucket-name/template-file-name
    delivery:
      githubToken:
        secretRef: github-token
      githubRepo: myuser/myrepo
  secrets:
  - name: github-token
    value: projects/project-id/secrets/secret-name/versions/latest

Dove:

  • githubToken è la variabile di configurazione utilizzata in questo esempio per fare riferimento al token GitHub archiviato in Secret Manager. Il nome della variabile specificato qui deve corrispondere al campo name in secrets.
  • bucket-name è il nome del bucket Cloud Storage in cui lo script di configurazione carica il file del template. Se il bucket non esiste, lo script di configurazione lo crea nel tuo progetto e verifica la proprietà del bucket prima di caricare i file.
  • template-file-name è il nome del file del template.
  • myuser/myrepo è il nome del repository in cui verranno creati i problemi.
  • project-id è l'ID del tuo progetto Google Cloud .
  • secret-name è il nome del secret che contiene il token GitHub.

Per visualizzare l'esempio, consulta il file di configurazione del sistema di notifica per Google Chat.

Per altri campi in base ai quali puoi filtrare, consulta la risorsa Build. Per altri esempi di filtri, consulta Utilizzo di CEL per filtrare gli eventi di build.

Esecuzione dello script di automazione

Per automatizzare la configurazione delle notifiche per il tuo sistema di notifica:

  1. Clona il repository cloud-build-notifiers.

  2. Configura Google Cloud CLI con l'ID progetto e la regione: 

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

    Dove:

    • project-id è l'ID progetto Google Cloud .
    • region è la regione in cui eseguire il deployment del sistema di notifica.

  3. Esegui questo comando nella directory principale del repository:

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

Dove:

  • config-path è il percorso del file di configurazione degli strumenti di notifica.
  • bucket-name è il nome del bucket Cloud Storage in cui lo script di configurazione carica i file di configurazione e di template. Se ometti -b, lo script genera un nome bucket con un suffisso casuale (notifiers-config-random-suffix).
  • template-path è il percorso del file del template dei notificatori. Il file del template degli strumenti di notifica contiene il template JSON ospitato su Cloud Storage e rappresenta il messaggio di notifica. Puoi includere il file del template dei tuoi notificatori come percorso utilizzando questa variabile o all'interno del campo uri del file di configurazione dei notificatori.

  • secret-name è il nome del secret archiviato in Secret Manager.

Dopo aver eseguito lo script, vedrai il seguente messaggio:

** NOTIFIER SETUP COMPLETE **

Il tuo notifier è ora configurato. Puoi visualizzare lo script completo nel repository cloud-build-notifiers o eseguire ./setup.sh --help per istruzioni sull'utilizzo associate allo script.

Passaggi successivi