Configurer les notifications de problèmes GitHub

Cloud Build peut vous avertir des mises à jour de compilation en vous envoyant des notifications aux canaux souhaités. Cette page explique comment configurer les notifications à l'aide de l'outil d'alerte GitHub concernant les problèmes.

Avant de commencer

Activer les API Cloud Build, Compute Engine, Cloud Run, Pub/Sub, and Secret Manager.
Activer les API

Installez Google Cloud CLI.

Configurer des notifications de problèmes GitHub

La section suivante explique comment configurer manuellement les notifications de problèmes GitHub à l'aide du système d'alerte GitHub des problèmes. Si vous préférez automatiser la configuration, consultez la page Automatiser la configuration des notifications.

Pour configurer les problèmes GitHub:

Créez un jeton d'accès personnel GitHub:
1. Accédez aux paramètres GitHub pour créer un jeton.
2. Sélectionnez le champ d'application repo.
  
  Remarque :Cette opération accorde un accès complet aux dépôts, y compris aux dépôts privés.
3. Cliquez sur Générer un jeton.
Stockez votre jeton GitHub dans Secret Manager:
1. Ouvrez la page Secret Manager dans la console Google Cloud:
  
  Ouvrir la page Secret Manager
2. Cliquez sur Créer un secret.
3. Attribuez un nom à votre secret.
4. Sous Valeur du secret, ajoutez votre jeton GitHub.
5. Pour enregistrer votre secret, cliquez sur Créer un secret.
Bien que votre compte de service Cloud Run puisse disposer du rôle Éditeur pour votre projet, le rôle Éditeur n'est pas suffisant pour accéder à votre secret dans Secret Manager. Vous devrez autoriser votre compte de service Cloud Run à accéder à votre secret:
1. Accédez à la page "IAM" de la console Google Cloud :
  
  Ouvrir la page IAM
2. Recherchez le compte de service Compute Engine par défaut associé à votre projet :
  
  Votre compte de service Compute Engine par défaut ressemble à ceci :
```
project-number-compute@developer.gserviceaccount.com
```
  Prenez note du compte de service Compute Engine par défaut.
  
  Remarque : Par défaut, Cloud Run exécute vos images de systèmes d'alerte avec le compte de service Compute Engine par défaut et l'utilise pour récupérer votre secret. Pour en savoir plus sur les comptes de service d'exécution, consultez la section Compte de service d'exécution.
3. Ouvrez la page Secret Manager dans la console Google Cloud:
  
  Ouvrir la page Secret Manager
4. Cliquez sur le nom du secret contenant votre jeton GitHub.
5. Dans l'onglet Autorisations, cliquez sur Ajouter un membre.
6. Ajoutez le compte de service par défaut Compute Engine associé à votre projet en tant que membre.
7. Sélectionnez l'autorisation Accesseur de secrets du gestionnaire de secrets comme rôle.
8. Cliquez sur Enregistrer.
Accordez à votre compte de service Cloud Run l'autorisation de lire les données des buckets Cloud Storage:
1. Accédez à la page "IAM" de la console Google Cloud :
  
  Ouvrir la page IAM
2. Recherchez le compte de service Compute Engine par défaut associé à votre projet :
  
  Votre compte de service Compute Engine par défaut ressemble à ceci :
```
project-number-compute@developer.gserviceaccount.com
```
3. Cliquez sur l'icône en forme de crayon sur la ligne contenant votre compte de service Compute Engine par défaut. L'onglet Modifier l'accès s'affiche.
4. Cliquez sur Ajouter un autre rôle.
5. Ajoutez le rôle suivant :
  - Lecteur des objets Storage
  Remarque : Si vous souhaitez accorder des autorisations au niveau du bucket plutôt qu'au niveau du projet, ajoutez le rôle Propriétaire des anciens objets de l'espace de stockage au bucket lors de sa création. Pour en savoir plus, consultez la section Rôles au niveau du projet et rôles au niveau du bucket.
6. Cliquez sur Enregistrer.
Écrivez un modèle de fichier de configuration pour décrire le format à respecter pour les problèmes GitHub créés:

Dans l'exemple de fichier de configuration de modèle suivant, les champs title et body utilisent des variables de substitution issues de la compilation:
```
{
    "title": "Build {{.Build.BuildTriggerId}}: {{.Build.Status}}",
    "body": "[{{.Build.ProjectId}}] {{.Build.BuildTriggerId}} status: **{{.Build.Status}}**\n\n[View Logs]({{.Build.LogUrl}})"
}
```
Pour voir l'exemple, consultez le modèle de fichier de configuration du système d'alerte GitHub des problèmes.

Vous pouvez définir des champs supplémentaires à partir des paramètres de corps disponibles sur le point de terminaison de l'API GitHub pour créer un problème.
Écrivez un fichier de configuration d'outil d'alerte pour configurer votre système d'alerte de problèmes GitHub et filtrer les événements de compilation:

Dans l'exemple de fichier de configuration du système d'alerte suivant, le champ filter utilise Common Expression Language avec la variable disponible, build, pour filtrer les événements de compilation à l'état 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
```
Où :
- githubToken est la variable de configuration utilisée dans cet exemple pour référencer le jeton GitHub stocké dans Secret Manager. Le nom de la variable que vous spécifiez ici doit correspondre au champ name sous secrets.
- bucket-name est le nom du bucket.
- template-file-name est le nom de votre fichier de modèle.
- myuser/myrepo est le nom du dépôt à partir duquel les problèmes seront créés.
- project-id est l'ID du projet Google Cloud.
- secret-name est le nom du secret contenant votre jeton GitHub.
Pour afficher l'exemple, consultez le fichier de configuration du système d'alerte pour le système de notification des problèmes GitHub.

Pour en savoir plus sur les champs supplémentaires que vous pouvez filtrer, consultez la ressource Build. Pour obtenir d'autres exemples de filtrage, consultez la section Utiliser le CEL pour filtrer les événements de compilation.
Importez votre fichier de configuration et votre fichier de modèle de système d'alerte dans un bucket Cloud Storage:
1. Si vous n'avez pas de bucket Cloud Storage, exécutez la commande suivante pour créer un bucket, où bucket-name est le nom que vous souhaitez attribuer au bucket, sous réserve des règles de dénomination.
```
gsutil mb gs://bucket-name/
```
2. Importez le fichier de configuration et le fichier de modèle du système d'alerte dans votre bucket:
```
gsutil cp config-file-name gs://bucket-name/config-file-name

gsutil cp config-file-name gs://bucket-name/config-file-name
```
  Où :
  - bucket-name est le nom du bucket.
  - config-file-name est le nom de votre fichier de configuration.
  - template-file-name est le nom de votre fichier de modèle.
Déployez votre système d'alerte dans Cloud Run :
```
 gcloud run deploy service-name \
   --image=us-east1-docker.pkg.dev/gcb-release/cloud-build-notifiers/githubissues:latest \
   --no-allow-unauthenticated \
   --update-env-vars=CONFIG_PATH=config-path,PROJECT_ID=project-id
```
Où :
- service-name correspond au nom du service Cloud Run dans lequel vous déployez l'image.
  
  Remarque :service-name fait référence au nouveau service d'alerte que vous créez.
- config-path est le chemin d'accès au fichier de configuration du système d'alerte pour votre système d'alerte GitHub des problèmes, gs://bucket-name/config-file-name.
- project-id est l'ID du projet Google Cloud.
La commande gcloud run deploy extrait la dernière version de l'image hébergée à partir d'Artifact Registry de Cloud Build. Cloud Build est compatible avec les images de système d'alerte pendant neuf mois. Après neuf mois, Cloud Build supprime la version de l'image. Si vous souhaitez utiliser une version d'image antérieure, vous devez spécifier la version sémantique complète du tag d'image dans l'attribut image de votre commande gcloud run deploy. Vous pouvez trouver les versions et les tags d'image précédents dans Artifact Registry.

Remarque : Lorsque vous exécutez cette commande, vous pouvez être invité à spécifier des arguments supplémentaires tels que --region ou --platform. Pour en savoir plus sur les paramètres que vous pouvez transmettre à la commande gcloud run deploy, consultez la page Déployer dans Cloud Run. Si vous ne parvenez pas à déployer votre système d'alerte à l'aide de cette commande, consultez le guide de dépannage Cloud Run pour savoir comment résoudre les erreurs de déploiement.
Accordez des autorisations Pub/Sub pour créer des jetons d'authentification dans votre projet :
```
 gcloud projects add-iam-policy-binding project-id \
   --member=serviceAccount:service-project-number@gcp-sa-pubsub.iam.gserviceaccount.com \
   --role=roles/iam.serviceAccountTokenCreator
```
Où :
- project-id est l'ID du projet Google Cloud.
- project-number est le numéro de votre projet Google Cloud.
Remarque :Si le compte de service Pub/Sub n'existe pas dans votre projet, consultez la section Créer et utiliser des abonnements.
Créez un compte de service pour représenter l'identité de votre abonnement Pub/Sub :
```
gcloud iam service-accounts create cloud-run-pubsub-invoker \
  --display-name "Cloud Run Pub/Sub Invoker"
```
Vous pouvez utiliser cloud-run-pubsub-invoker ou utiliser un nom unique dans votre projet Google Cloud.
Accordez au compte de service cloud-run-pubsub-invoker l'autorisation Cloud Run Invoker :
```
gcloud run services add-iam-policy-binding service-name \
   --member=serviceAccount:cloud-run-pubsub-invoker@project-id.iam.gserviceaccount.com \
   --role=roles/run.invoker
```
Où :
- service-name correspond au nom du service Cloud Run dans lequel vous déployez l'image.
- project-id est l'ID du projet Google Cloud.
Créez le sujet cloud-builds pour recevoir des messages de mise à jour de compilation pour votre système d'alerte :
```
gcloud pubsub topics create cloud-builds
```
Créez un abonné push Pub/Sub pour votre système d'alerte :
```
 gcloud pubsub subscriptions create subscriber-id \
   --topic=cloud-builds \
   --push-endpoint=service-url \
   --push-auth-service-account=cloud-run-pubsub-invoker@project-id.iam.gserviceaccount.com
```
Où :
- subscriber-id est le nom que vous souhaitez donner à votre abonnement.
- service-url est l'URL générée par Cloud Run pour votre nouveau service.
- project-id est l'ID du projet Google Cloud.

Les notifications pour votre projet Cloud Build sont maintenant configurées. La prochaine fois que vous appellerez une compilation, un problème sera créé sur le dépôt GitHub défini si la compilation correspond au filtre que vous avez configuré.

Utiliser le CEL pour filtrer les événements de compilation

Cloud Build utilise le CEL avec la variable, build, sur les champs répertoriés dans la ressource Compilation afin d'accéder aux champs associés à votre événement de compilation, tels que votre ID de déclencheur, votre liste d'images, ou vos valeurs de substitution. Vous pouvez utiliser la chaîne filter pour filtrer les événements de compilation dans votre fichier de configuration de compilation à l'aide de n'importe quel champ répertorié dans la ressource Compilation. Pour trouver la syntaxe exacte associée à votre champ, consultez le fichier cloudbuild.proto.

Filtrer par ID de déclencheur

Pour filtrer par ID de déclencheur, spécifiez la valeur de votre ID de déclencheur dans le champ filter à l'aide de build.build_trigger_id, où trigger-id est votre ID de déclencheur sous forme de chaîne :

filter: build.build_trigger_id == trigger-id

Filtrer par état

Pour filtrer par état, spécifiez l'état de la compilation que vous souhaitez filtrer dans le champ filter à l'aide de build.status.

L'exemple suivant montre comment filtrer les événements de compilation dotés de l'état SUCCESS à l'aide du champ filter :

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

Vous pouvez également filtrer les compilations présentant des états différents. L'exemple suivant montre comment filtrer les événements de compilation dont l'état est SUCCESS, FAILURE ou TIMEOUT à l'aide du champ filter :

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

Pour afficher des valeurs d'état supplémentaires que vous pouvez filtrer, consultez la section État dans la documentation de référence sur les ressources de compilation.

Filtrer par tag

Pour filtrer par tag, spécifiez la valeur de votre tag dans le champ filter à l'aide de build.tags, où tag-name est le nom de votre tag :

filter: tag-name in build.tags

Vous pouvez appliquer un filtre en fonction du nombre de tags spécifiés dans votre événement de compilation à l'aide de size. Dans l'exemple suivant, le champ filter filtre les événements de compilation comportant exactement deux tags spécifiés, avec un tag spécifié en tant que v1 :

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

Filtrer par images

Pour filtrer par images, spécifiez la valeur de votre image dans le champ filter à l'aide de build.images, où image-name correspond au nom complet de votre image, tel que répertorié dans Artifact Registry, par exemple us-east1-docker.pkg.dev/my-project/docker-repo/image-one:

filter: image-name in build.images

Dans l'exemple suivant, filter filtre les événements de compilation dont les noms d'image sont us-east1-docker.pkg.dev/my-project/docker-repo/image-one ou us-east1-docker.pkg.dev/my-project/docker-repo/image-two:

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

Filtrer par date et heure

Vous pouvez filtrer les événements de compilation en fonction de la date et l'heure de création, de début ou de fin d'une compilation en spécifiant l'une des options suivantes dans votre champ filter : build.create_time, build.start_time ou build.finish_time

Dans l'exemple suivant, le champ filter utilise timestamp pour filtrer les événements de compilation dont la date et l'heure de requête pour créer la compilation sont fixées au 20 juillet 2020 à 6h00 :

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

Vous pouvez également filtrer les événements de compilation par comparaisons horaires. Dans l'exemple suivant, le champ filter utilise timestamp pour filtrer les événements de compilation dont le début est compris entre le 20 juillet 2020 à 6h00 et le 30 juillet 2020 à 6h00.

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

Pour en savoir plus sur la façon dont les fuseaux horaires sont exprimés dans le CEL, consultez la définition de langage pour les fuseaux horaires.

Pour filtrer par durée de compilation, vous pouvez utiliser duration pour comparer les horodatages. Dans l'exemple suivant, le champ filter utilise duration pour filtrer les événements de compilation dont la compilation a duré au moins cinq minutes :

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

Filtrer par substitution

Vous pouvez filtrer par substitution en spécifiant la variable de substitution dans le champ filter à l'aide de build.substitutions. Dans l'exemple suivant, le champ filter répertorie les compilations contenant la variable de substitution substitution-variable et vérifie si substitution-variable correspond à l'élément substitution-value spécifié :

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

Où :

substitution-variable est le nom de votre variable de substitution.
substitution-value est le nom de votre valeur de substitution.

Vous pouvez également filtrer par valeur de variable de substitution par défaut. Dans l'exemple suivant, le champ filter répertorie les compilations portant le nom de branche master et les compilations portant le nom de dépôt github.com/user/my-example-repo. Les variables de substitution par défaut BRANCH_NAME et REPO_NAME sont transmises sous forme de clés à build.substitutions :

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

Si vous souhaitez filtrer les chaînes à l'aide d'expressions régulières, vous pouvez utiliser la fonction matches intégrée. Dans l'exemple ci-dessous, le champ filter filtre les compilations dont l'état est FAILURE ou TIMEOUT, et qui disposent également d'une variable de substitution de compilation TAG_NAME avec une valeur correspondant à l'expression régulière 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}$")`

Pour afficher la liste des valeurs de substitution par défaut, consultez la section Utiliser des substitutions par défaut.

Étapes suivantes

Apprenez-en plus sur les systèmes d'alerte Cloud Build.
Découvrez comment vous abonner aux notifications de compilation.
Découvrez comment écrire un fichier de configuration de compilation Cloud Build.