配置流水线通知订阅

什么是流水线通知订阅

流水线通知订阅是一种在流水线系统中，让用户或系统组件能够接收与流水线相关事件通知的机制。通过订阅特定的流水线事件，相关人员或系统可以及时了解流水线的运行状态、任务执行结果等信息。流水线支持配置事件通知，包括站内消息通知、邮件通知、飞书通知、企业微信通知和钉钉通知，请根据需要选择通知方式。

约束与限制

• 默认情况下，服务动态通知都发送，邮件通知都不发送。

前提条件

• 已开通并授权使用CodeArts Pipeline。
• 当用户角色为“项目管理员”或者“流水线创建者”，可以配置流水线通知订阅，权限配置请参考授权流水线服务。

配置流水线服务动态通知

通过服务动态的方式推送通知。流水线被删除、执行失败、执行成功以及配置被更新时，可以配置给创建人、执行人、收藏人发送服务动态。

1. 访问CodeArts Pipeline首页。
2. 在流水线列表页搜索目标流水线，单击操作列，选择“编辑”。
3. 进入流水线“任务编排”页面，切换至“通知订阅”页面。
4. 单击“系统消息”下“站内消息通知”，根据需要开启/关闭通知。
   • 在流水线首页右上角单击，会弹出“通知”侧滑框，即可查看通知消息。
   图1 配置服务动态通知
   

5. 配置完成后，单击“保存”，弹出“保存信息成功”提示，完成流水线的保存。

配置流水线邮件消息通知

通过邮件通知的方式推送通知。流水线执行成功、执行失败、被删除以及配置被更新时，可以配置给创建人、执行人、收藏人发送邮件。

1. 访问CodeArts Pipeline首页。
2. 在流水线列表页搜索目标流水线，单击操作列，选择“编辑”。
3. 进入流水线“任务编排”页面，切换至“通知订阅”页面。
4. 单击“系统消息”下“邮件通知”，根据需要开启/关闭通知。
   图2 配置邮件通知
   

5. 配置完成后，单击“保存”，弹出“保存信息成功”提示，完成流水线的保存。

配置流水线企业微信通知

将流水线信息推送到企业微信。

1. 访问CodeArts Pipeline首页。
2. 在流水线列表页搜索目标流水线，单击操作列，选择“编辑”。
3. 进入流水线“任务编排”页面，切换至“通知订阅”页面。
4. 单击“第三方通知”下“企业微信”，根据需要填写通知信息，填写完成后即可激活通知。
   图3 配置企业微信通知
   

   表1 配置企业微信通知

   操作项	说明
   URL	填写企业微信机器人通知URL，只能以http://或https://开头，例如https://xxxxx。
   事件类型	选择要通知的事件，可全选或选择已完成、失败、暂停、挂起、忽略五种事件类型。
   通知内容	选择要通知的内容，可全选或选择流水线名称、流水线执行描述、执行人、触发信息、项目名称、执行时间、运行状态、分支、Commit Id九种通知内容。
   @user_id	填写要接受通知的企业微信的user_id，多个user_id之间以逗号分隔。

5. 配置完成后，单击“保存”，弹出“保存信息成功”提示，完成流水线的保存。

配置流水线钉钉通知

将流水线信息推送到钉钉。

1. 访问CodeArts Pipeline首页。
2. 在流水线列表页搜索目标流水线，单击操作列，选择“编辑”。
3. 进入流水线“任务编排”页面，切换至“通知订阅”页面。
4. 单击“第三方通知”下“钉钉”，根据需要填写通知信息，填写完成后即可激活通知。
   图4 配置钉钉通知
   

   表2 配置钉钉通知

   操作项	说明
   URL	填写钉钉机器人通知URL，只能以http://或https://开头，例如https://xxxxx。
   事件类型	选择要通知的事件，可全选或选择已完成、失败、暂停、挂起、忽略五种事件类型。
   通知内容	选择要通知的内容，可全选或选择流水线名称、流水线执行描述、执行人、触发信息、项目名称、执行时间、运行状态、分支、Commit Id九种通知内容。
   @user_id	填写要接受通知的钉钉的user_id，多个user_id之间以逗号分隔。
   @手机号	填写要接受通知的手机号，多个手机号之间以逗号分隔。
   加签密钥	钉钉自定义机器人可以开启安全设置，若未使用加签，无需填写加签密钥。

5. 配置完成后，单击“保存”，弹出“保存信息成功”提示，完成流水线的保存。

配置流水线飞书通知

将流水线信息推送到飞书。

1. 访问CodeArts Pipeline首页。
2. 在流水线列表页搜索目标流水线，单击操作列，选择“编辑”。
3. 进入流水线“任务编排”页面，切换至“通知订阅”页面。
4. 单击“第三方通知”下“飞书”，根据需要填写通知信息，填写完成后即可激活通知。
   图5 配置飞书通知
   

   表3 配置飞书通知

   操作项	说明
   URL	填写飞书机器人通知URL，只能以http://或https://开头，例如https://xxxxx。
   事件类型	选择要通知的事件，可全选或选择已完成、失败、暂停、挂起、忽略五种事件类型。
   通知内容	选择要通知的内容，可全选或选择流水线名称、流水线执行描述、执行人、触发信息、项目名称、执行时间、运行状态、分支、Commit Id九种通知内容。
   @user_id	填写要接受通知的飞书的user_id，多个user_id之间以逗号分隔。
   加签密钥	飞书自定义机器人可以开启安全设置，若未使用加签，无需填写加签密钥。

5. 配置完成后，单击“保存”，弹出“保存信息成功”提示，完成流水线的保存。