Les notifications sont un moyen de communiquer avec vos équipes et de leur donner l'état de vos pipelines dans Code Stream.

Pour envoyer des notifications lorsqu'un pipeline s'exécute, vous pouvez configurer des notifications Code Stream en fonction de l'état de l'intégralité du pipeline, de l'étape ou de la tâche.

  • Une notification par e-mail envoie un e-mail lors des événements suivants :
    • Achèvement, attente, échec, annulation ou démarrage du pipeline.
    • Exécution, échec ou démarrage d'une étape.
    • Exécution, attente, échec ou démarrage d'un tâche.
  • Une notification par ticket crée un ticket et l'attribue à un membre de l'équipe lors des événements suivants :
    • Échec ou exécution du pipeline.
    • Échec de l'étape.
    • Échec de la tâche.
  • Une notification Webhook envoie une demande à une autre application lors des événements suivants :
    • Échec, achèvement, attente, annulation ou démarrage du pipeline.
    • Échec, achèvement ou démarrage de l'étape.
    • Échec, fin, attente ou démarrage de la tâche.
Par exemple, vous pouvez configurer une notification par e-mail sur une tâche d'opération d'utilisateur pour obtenir une approbation à un point spécifique de votre pipeline. Lorsque le pipeline s'exécute, cette tâche envoie un e-mail à la personne qui doit approuver la tâche. Si le délai d'expiration de la tâche Opération de l'utilisateur est défini en jours, heures ou minutes, l'utilisateur requis doit approuver le pipeline avant l'expiration de la tâche. Sinon, le pipeline échoue comme prévu.

Pour créer un ticket Jira en cas d'échec d'une tâche de pipeline, vous pouvez configurer une notification. Pour envoyer une demande à un canal Slack concernant l'état d'un pipeline basé sur l'événement de pipeline, vous pouvez configurer une notification Webhook.

Vous pouvez utiliser des variables dans tous les types de notifications. Par exemple, vous pouvez utiliser ${var} dans l'URL d'une notification Webhook.

Conditions préalables

  • Vérifiez qu'un ou plusieurs pipelines sont créés. Consultez les cas d'utilisation dans la section Didacticiels d'utilisation de VMware Code Stream.
  • Pour envoyer des notifications par e-mail, confirmez que vous pouvez accéder à un serveur de messagerie actif. Pour obtenir une assistance, consultez votre administrateur.
  • Pour créer des tickets, par exemple un ticket Jira, confirmez que le point de terminaison existe. Reportez-vous à la section Présentation des points de terminaison dans Code Stream.
  • Pour envoyer une notification basée sur une intégration, vous pouvez créer une notification Webhook. Ensuite, confirmez que le Webhook est ajouté et qu'il fonctionne. Vous pouvez utiliser des notifications avec des applications telles que Slack, GitHub ou GitLab.
  • Si un Webhook se connecte à un référentiel de code source sur site, tel qu'une instance sur site de GitHub Enterprise, confirmez qu'un proxy cloud existe. Pour consulter un exemple d'ajout d'un proxy cloud, reportez-vous à Configuration de VMware Code Stream pour modéliser le processus de publication.

Procédure

  1. Ouvrez un pipeline.
  2. Pour créer une notification sur l'état du pipeline entier, ou sur l'état d'une étape ou d'une tâche :
    Pour créer une notification pour : Actions :
    L'état du pipeline Cliquez sur une zone vide dans le canevas du pipeline.
    L'état d'une étape Cliquez sur une zone vide dans une étape du pipeline.
    L'état d'une tâche Cliquez sur une tâche dans une étape du pipeline.
  3. Cliquez sur l'onglet Notifications.
  4. Cliquez sur Ajouter, sélectionnez le type de notification et configurez les détails de la notification.
  5. Pour créer une notification Slack lorsqu'un pipeline réussit, créez une notification webhook.
    1. Sélectionnez Webhook.
    2. Pour configurer la notification Slack, entrez les informations.
    3. Cliquez sur Enregistrer.
      Lorsque vous configurez une notification Slack pour l'achèvement du pipeline, vous incluez l'URL Webhook, l'action, le proxy cloud, la charge utile et les en-têtes.
    4. Lorsque le pipeline s'exécute, le canal Slack reçoit la notification de l'état du pipeline. Par exemple, les utilisateurs peuvent voir les éléments suivants sur le canal Slack :
      Codestream APP [12:01 AM]
      Tested by User1 - Staging Pipeline 'User1-Pipeline', Pipeline ID 'e9b5884d809ce2755728177f70f8a' succeeded
  6. Pour créer un ticket Jira, configurez les informations de ticket.
    1. Sélectionnez Ticket.
    2. Pour configurer la notification JIRA, entrez les informations.
    3. Cliquez sur Enregistrer.
      Lorsque vous configurez des notifications de ticket Jira pour les échecs de pipeline, vous incluez le projet Jira, le type de problème, le destinataire et le résumé.

Résultats

Félicitations ! Vous avez appris que vous pouvez créer différents types de notifications dans plusieurs zones de votre pipeline dans Code Stream.

Que faire ensuite

Pour obtenir un exemple détaillé de création d'une notification, reportez-vous à la section Création d'un ticket JIRA dans VMware Code Stream en cas d'échec d'une tâche de pipeline.