Configurare le notifiche relative ai problemi di GitHub

Sperimentale — githubissues

Questa funzionalità è soggetta ai "Termini delle Offerte pre-GA" nella sezione Termini di servizio generali dei Termini specifici dei servizi. Le funzionalità pre-GA sono disponibili "così come sono" e potrebbero avere un supporto limitato. Per saperne di più, consulta le descrizioni della fase di lancio.

Cloud Build può inviarti notifiche sugli aggiornamenti delle build inviandole ai canali selezionati. Questa pagina spiega come configurare le notifiche utilizzando GitHub Issues notifier.

Prima di iniziare

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

  Enable the APIs

• Installa Google Cloud CLI.

Configurazione delle notifiche relative ai problemi di GitHub

La sezione seguente spiega come configurare manualmente le notifiche dei problemi di GitHub utilizzando lo strumento di notifica dei problemi di GitHub. Se invece vuoi automatizzare la configurazione, consulta la sezione Automatizzazione della configurazione per le notifiche.

Per configurare GitHub Issues:

1. Crea un token di accesso personale GitHub:

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

   2. Seleziona l'ambito repo.

      Nota: questo concede l'accesso completo ai repository, inclusi quelli privati.

   3. Fai clic su Genera token.

2. Archivia il token GitHub 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.

3. Anche se il account di servizio Cloud Run potrebbe avere il ruolo Editor per il tuo progetto, il ruolo Editor non è sufficiente per accedere al tuo secret in Secret Manager. Per concedere al account di servizio Cloud Run l'accesso al tuo secret:

   1. Vai alla pagina IAM nella console Google Cloud :

      Apri la pagina IAM

   2. Individua l'account di servizio predefinito di Compute Engine associato al tuo progetto:

      Il tuo service account predefinito di Compute Engine sarà simile al seguente:

      [e-mail]
      

      Prendi nota del tuo service account predefinito di Compute Engine.

      Nota: per impostazione predefinita, Cloud Run esegue le immagini di notifica con l'account di servizio predefinito di Compute Engine e lo utilizza per recuperare il secret. Per saperne di più sui service account di runtime, consulta Service account di runtime.

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

      Apri la pagina Secret Manager

   4. Fai clic sul nome del secret che contiene il secret per il token GitHub.

   5. Nella scheda Autorizzazioni, fai clic su Aggiungi membro.

   6. Aggiungi l'account di servizio predefinito di Compute Engine associato al tuo progetto come membro.

   7. Seleziona l'autorizzazione Secret Manager Secret Accessor come ruolo.

   8. Fai clic su Salva.

4. Concedi al account di servizio Cloud Run l'autorizzazione a leggere dai bucket Cloud Storage:

   1. Vai alla pagina IAM nella console Google Cloud :

      Apri la pagina IAM

   2. Individua l'account di servizio predefinito di Compute Engine associato al tuo progetto:

      Il tuo service account predefinito di Compute Engine sarà simile al seguente:

      [e-mail]
      

   3. Fai clic sull'icona a forma di matita nella riga contenente il service account predefinito di Compute Engine. Viene visualizzata la scheda Accesso in modifica.

   4. Fai clic su Aggiungi un altro ruolo.

   5. Aggiungi il seguente ruolo:

      • Storage Object Viewer
      Nota: se vuoi concedere le autorizzazioni a livello di bucket anziché a livello di progetto, aggiungi il ruolo Proprietario oggetti legacy Storage al bucket quando ne crei uno. Per saperne di più, consulta Concedere ruoli a livello di progetto, di bucket o di cartella gestita.

   6. Fai clic su Salva.

5. 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 la notifica dei problemi di GitHub.

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

6. Scrivi un file di configurazione del sistema di notifica per configurare il sistema di notifica dei problemi di GitHub e filtrare gli eventi di build:

   Nel seguente file di configurazione del sistema di notifica, il campo filter utilizza il Common Expression Language con la variabile disponibile build per filtrare gli eventi di build con lo 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 tuo bucket.
   • template-file-name è il nome del file del modello.
   • 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 tuo secret che contiene il token GitHub.

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

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

7. Carica il file di configurazione del sistema di notifica e il file del modello in un bucket Cloud Storage:

   1. Se non hai un bucket Cloud Storage, esegui il comando seguente per creare un bucket, dove bucket-name è il nome che vuoi assegnare al bucket, soggetto ai requisiti di denominazione.

      gcloud storage buckets create gs://bucket-name/
      

   2. Carica il file di configurazione del sistema di notifica e il file modello nel bucket:

      gcloud storage cp config-file-name gs://bucket-name/config-file-name
      
      gcloud storage cp template-file-name gs://bucket-name/template-file-name
      

      Dove:

      • bucket-name è il nome del tuo bucket.
      • config-file-name è il nome del file di configurazione.
      • template-file-name è il nome del file del modello.

8. Esegui il deployment del notifier in Cloud Run:

    gcloud run deploy service-name \
      --image=us-east1-docker.pkg.dev/gcb-release/cloud-build-notifiers/slack:latest \
      --no-allow-unauthenticated \
      --update-env-vars=CONFIG_PATH=config-path,PROJECT_ID=project-id
   

   Dove:

   • service-name è il nome del servizio Cloud Run in cui esegui il deployment dell'immagine.
   • config-path è il percorso del file di configurazione del sistema di notifica per il sistema di notifica Slack, gs://bucket-name/config-file-name.
   • project-id è l'ID del tuo progetto Google Cloud .

   Il comando gcloud run deploy recupera l'ultima versione dell'immagine ospitata da Artifact Registry di proprietà di Cloud Build. Cloud Build supporta le immagini di notifica per nove mesi. Dopo nove mesi, Cloud Build elimina la versione dell'immagine. Se vuoi utilizzare una versione precedente dell'immagine, devi specificare la versione semantica completa del tag immagine nell'attributo image del comando gcloud run deploy. Le versioni e i tag precedenti delle immagini sono disponibili in Artifact Registry.

   Nota: durante l'esecuzione di questo comando, potrebbe esserti chiesto di specificare argomenti aggiuntivi come --region o --platform. Per scoprire di più sui parametri che puoi passare al comando gcloud run deploy, consulta Deployment in Cloud Run. Se non riesci a eseguire il deployment del notifier utilizzando questo comando, consulta la guida alla risoluzione dei problemi di Cloud Run per trovare soluzioni su come risolvere gli errori di deployment.

9. Concedi le autorizzazioni Pub/Sub per creare token di autenticazione nel tuo progetto Google Cloud :

    gcloud projects add-iam-policy-binding project-id \
      --member=serviceAccount:[e-mail] \
      --role=roles/iam.serviceAccountTokenCreator
   

   Dove:

   • project-id è l'ID del tuo progetto Google Cloud .
   • project-number è il numero del tuo progetto Google Cloud .
   Nota: se l'account di servizio Pub/Sub non esiste nel tuo progetto, consulta Creare e utilizzare le sottoscrizioni.

10. Crea un account di servizio per rappresentare l'identità della sottoscrizione Pub/Sub:

    gcloud iam service-accounts create cloud-run-pubsub-invoker \
      --display-name "Cloud Run Pub/Sub Invoker"
    

    Puoi utilizzare cloud-run-pubsub-invoker o un nome univoco all'interno del tuo progetto Google Cloud .

11. Concedi all'account di servizio cloud-run-pubsub-invoker l'autorizzazione Invoker di Cloud Run:

    gcloud run services add-iam-policy-binding service-name \
       --member=serviceAccount:[e-mail] \
       --role=roles/run.invoker
    

    Dove:

    • service-name è il nome del servizio Cloud Run in cui esegui il deployment dell'immagine.

    • project-id è l'ID del tuo progetto Google Cloud .

12. Crea l'argomento cloud-builds per ricevere messaggi di aggiornamento della build per il tuo notifier:

    gcloud pubsub topics create cloud-builds
    

    Puoi anche definire un nome dell'argomento personalizzato nel file di configurazione della build in modo che i messaggi vengano inviati all'argomento personalizzato. In questo caso, devi creare un argomento con lo stesso nome dell'argomento personalizzato:

    gcloud pubsub topics create topic-name
    

    Per ulteriori informazioni, consulta la sezione Argomenti Pub/Sub per le notifiche di build.

13. Crea un abbonato push Pub/Sub per il tuo sistema di notifica:

     gcloud pubsub subscriptions create subscriber-id \
       --topic=cloud-builds \
       --push-endpoint=service-url \
       --push-auth-service-account=[e-mail]
    

    Dove:

    • subscriber-id è il nome che vuoi assegnare al tuo abbonamento.
    • service-url è l'URL generato da Cloud Run per il tuo nuovo servizio.
    • project-id è l'ID del tuo progetto Google Cloud .

Le notifiche per il tuo progetto Cloud Build sono ora configurate. La volta successiva che richiami una build, verrà creato un problema nel repository GitHub definito se la build corrisponde al filtro che hai configurato.

Utilizzo di CEL per filtrare gli eventi di build

Cloud Build utilizza CEL con la variabile build nei campi elencati nella risorsa Build per accedere ai campi associati all'evento di build, ad esempio l'ID trigger, l'elenco delle immagini o i valori di sostituzione. Puoi utilizzare la stringa filter per filtrare gli eventi di build nel file di configurazione della build utilizzando qualsiasi campo elencato nella risorsa Build. Per trovare la sintassi esatta associata al tuo campo, consulta il file cloudbuild.proto.

Filtro per ID attivatore

Per filtrare in base all'ID trigger, specifica il valore dell'ID trigger nel campo filter utilizzando build.build_trigger_id, dove trigger-id è l'ID trigger come stringa:

filter: build.build_trigger_id == trigger-id

Nota:l'ID attivatore non è il nome dell'attivatore. Per ottenere l'ID trigger, esegui questo comando: gcloud beta builds triggers describe trigger-name, dove trigger-name è il nome del trigger. Il comando elencherà i campi associati al trigger, incluso l'ID trigger.

Filtrare per stato

Per filtrare in base allo stato, specifica lo stato della build in base al quale vuoi filtrare nel campo filter utilizzando build.status.

L'esempio seguente mostra come filtrare gli eventi di build con uno stato SUCCESS utilizzando il campo filter:

filter: build.status == Build.Status.SUCCESS

Puoi anche filtrare le build con stati diversi. L'esempio seguente mostra come filtrare gli eventi di build con stato SUCCESS, FAILURE o TIMEOUT utilizzando il campo filter:

filter: build.status in [Build.Status.SUCCESS, Build.Status.FAILURE, Build.Status.TIMEOUT]

Per visualizzare altri valori di stato in base ai quali puoi filtrare, consulta la sezione Stato nella documentazione di riferimento della risorsa Build.

Filtrare per tag

Per filtrare in base al tag, specifica il valore del tag nel campo filter utilizzando build.tags, dove tag-name è il nome del tag:

filter: tag-name in build.tags

Puoi filtrare in base al numero di tag specificato nell'evento di build utilizzando size. Nell'esempio seguente, il campo filter filtra gli eventi di build che hanno esattamente due tag specificati, uno dei quali è v1:

filter: size(build.tags) == 2 && "v1" in build.tags

Filtrare per immagini

Per filtrare in base alle immagini, specifica il valore dell'immagine nel campo filter utilizzando build.images, dove image-name è il nome completo dell'immagine elencata in Artifact Registry, ad esempio us-east1-docker.pkg.dev/my-project/docker-repo/image-one:

filter: image-name in build.images

Nell'esempio seguente, filter filtra gli eventi di build che hanno us-east1-docker.pkg.dev/my-project/docker-repo/image-one o us-east1-docker.pkg.dev/my-project/docker-repo/image-two specificati come nomi delle immagini:

filter: "us-east1-docker.pkg.dev/my-project/docker-repo/image-one" in build.images || "us-east1-docker.pkg.dev/my-project/docker-repo/image-one" in build.images

Filtro per ora

Puoi filtrare gli eventi di build in base all'ora di creazione, all'ora di inizio o all'ora di fine di una build specificando una delle seguenti opzioni nel campo filter: build.create_time, build.start_time o build.finish_time.

Nell'esempio seguente, il campo filter utilizza timestamp per filtrare gli eventi di build con un orario di richiesta per creare la build il 20 luglio 2020 alle 06:00:

filter: build.create_time == timestamp("2020-07-20:T06:00:00Z")

Puoi anche filtrare gli eventi di build in base ai confronti temporali. Nell'esempio seguente, il campo filter utilizza timestamp per filtrare gli eventi di build con un orario di inizio compreso tra le 06:00 del 20 luglio 2020 e le 06:00 del 30 luglio 2020.

filter: timestamp("2020-07-20:T06:00:00Z") >= build.start_time && build.start_time <= timestamp("2020-07-30:T06:00:00Z")

Per scoprire di più su come vengono espressi i fusi orari in CEL, consulta la definizione del linguaggio per i fusi orari.

Per filtrare in base alla durata di una build, puoi utilizzare duration per confrontare i timestamp. Nell'esempio seguente, il campo filter utilizza duration per filtrare gli eventi di build con build eseguite per almeno cinque minuti:

filter: build.finish_time - build.start_time >= duration("5m")

Nota: i timestamp sono in formato "Zulu" UTC RFC 3339, con risoluzione al nanosecondo e fino a nove cifre frazionarie.

Filtro per sostituzione

Puoi filtrare per sostituzione specificando la variabile di sostituzione nel campo filter utilizzando build.substitutions. Nel seguente esempio, il campo filter elenca le build che contengono la variabile di sostituzione substitution-variable e controlla se substitution-variable corrisponde al substitution-value specificato:

filter: build.substitutions[substitution-variable] == substitution-value

Dove:

• substitution-variable è il nome della variabile di sostituzione.
• substitution-value è il nome del valore di sostituzione.

Puoi anche filtrare in base ai valori delle variabili di sostituzione predefinite. Nell'esempio seguente, il campo filter elenca le build con il nome del ramo master e le build con il nome del repository github.com/user/my-example-repo. Le variabili di sostituzione predefinite BRANCH_NAME e REPO_NAME vengono trasmesse come chiavi a build.substitutions:

filter: build.substitutions["BRANCH_NAME"] == "master" && build.substitutions["REPO_NAME"] == "github.com/user/my-example-repo"

Se vuoi filtrare le stringhe utilizzando le espressioni regolari, puoi utilizzare la funzione integrata matches. Nell'esempio seguente, il campo filter filtra le build con stato FAILURE o TIMEOUT e che hanno anche una variabile di sostituzione della build TAG_NAME con un valore che corrisponde all'espressione regolare v{DIGIT}.{DIGIT}.{3 DIGITS}).

filter: build.status in [Build.Status.FAILURE, Build.Status.TIMEOUT] && build.substitutions["TAG_NAME"].matches("^v\\d{1}\\.\\d{1}\\.\\d{3}$")

Per visualizzare un elenco di valori di sostituzione predefiniti, consulta la sezione Utilizzare le sostituzioni predefinite.

Passaggi successivi

• Scopri di più sui notifier di Cloud Build.
• Scopri come iscriverti alle notifiche di build.
• Scopri come scrivere un file di configurazione della build di Cloud Build.