通知是与团队进行通信,让他们了解管道在 Code Stream 中的状态的方式。

要在管道运行时发送通知,可以基于整个管道、阶段或任务的状态配置 Code Stream 通知。

  • 电子邮件通知会在以下时候发送电子邮件:
    • 管道完成、等待、失败、取消或启动。
    • 阶段完成、失败或启动。
    • 任务完成、等待、失败或启动。
  • 票证通知会在以下时候创建一个票证并将其分配给团队成员:
    • 管道失败或完成。
    • 阶段失败。
    • 任务失败。
  • Webhook 通知会在以下时候向另一个应用程序发送一个请求:
    • 管道失败、完成、等待、取消或启动。
    • 阶段失败、完成或启动。
    • 任务失败、完成、等待或启动。
例如,可以在用户操作任务上配置一个电子邮件通知,以便在管道中的特定点获得批准。当管道运行时,此任务向必须批准该任务的人员发送电子邮件。如果用户操作任务设置了过期超时(以天、小时或分钟为单位),则要求的用户必须在任务过期之前批准管道。否则,管道将会按预期失败。

要在管道任务失败时创建 Jira 票证,可以配置通知。或者,要根据管道事件向 Slack 通道发送有关管道状态的请求,可以配置 Webhook 通知。

可以在所有类型的通知中使用变量。例如,可以在 Webhook 通知的 URL 中使用 ${var}

前提条件

  • 验证是否是否以创建一个或多个管道。请参见VMware Code Stream 使用教程中的用例。
  • 要发送电子邮件通知,请确认您可以访问正在运行的电子邮件服务器。要获得帮助,请咨询您的管理员。
  • 要创建票证(如 Jira 票证),请确认端点存在。请参见什么是 Code Stream 中的端点
  • 要基于集成发送通知,可以创建 Webhook 通知。然后,确认 Webhook 已添加并正常运行。您可以将通知用于诸如 Slack、GitHub 或 GitLab 等应用程序。
  • 如果 Webhook 连接到内部部署源代码存储库(例如 GitHub Enterprise 的内部部署实例),请确认云代理存在。有关添加云代理的示例,请参见设置 VMware Code Stream 以对发布流程进行建模

过程

  1. 打开管道。
  2. 要为整个管道的状态或阶段或任务的状态创建通知:
    为以下状态创建通知: 执行的操作:
    管道状态 单击管道画布上的空白区域。
    阶段状态 单击管道的某个阶段中的空白区域。
    任务的状态 单击管道的某个阶段中的任务。
  3. 单击通知选项卡。
  4. 单击添加,选择通知类型,并配置通知详细信息。
  5. 要在管道成功时创建 Slack 通知,请创建一个 Webhook 通知。
    1. 选择 Webhook
    2. 要配置 Slack 通知,请输入信息。
    3. 单击保存
      为管道完成配置 Slack 通知时,包括 Webhook URL、操作、云代理、负载和标头。
    4. 当管道运行时,Slack 通道将收到管道状态的通知。例如,用户可能会在 Slack 通道上看到以下内容:
      Codestream APP [12:01 AM]
      Tested by User1 - Staging Pipeline 'User1-Pipeline', Pipeline ID 'e9b5884d809ce2755728177f70f8a' succeeded
  6. 要创建 Jira 票证,请配置票证信息。
    1. 选择票证
    2. 要配置 Jira 通知,请输入 信息。
    3. 单击保存
      为管道失败配置 Jira 票证通知时,包括 Jira 项目、问题类型、被分配用户和摘要。

结果

恭喜!您已了解到,您可以在 Code Stream 的管道的多个区域中创建各种类型的通知。

后续步骤

有关如何创建通知的详细示例,请参见管道任务失败时如何在 VMware Code Stream 中创建 Jira 票证