配置代码检查任务消息通知
CodeArts Check的通知设置支持租户级、系统项目级、服务项目级和任务级,您可以根据实际需求,设置代码检查任务事件类型的通知方式。入口分别如下:
- 租户级消息通知,详情可参考配置租户级第三方消息通知。
- 系统项目级:详情可参考项目级消息通知配置。
- 服务项目级:进入项目详情页面,选择“代码 > 代码检查 > 配置中心 > 通知管理”。
- 任务级:进入代码检查详情页面,选择。本节以任务级通知设置为例介绍操作步骤。
通知配置生效情况如下:
- 将任务级消息通知配置页面的“使用项目通知设置”开关设置为开启状态:使用系统项目级通知配置。
- 将任务级消息通知配置页面的“使用项目通知设置”开关设置为关闭状态:任务级配置和服务项目级均生效。
- 租户级消息通知的配置不影响其他三个级别的配置结果。
配置消息通知
代码检查服务支持发送服务动态/邮件通知、企业微信消息通知,钉钉消息通知和飞书消息通知。
配置租户级第三方消息通知
CodeArts Check支持对租户级任务排队的事件发送消息通知。代码检查任务频繁排队时,至少间隔5分钟发送一次通知。
仅te_admin账号、租户空间管理员和租户空间所有者,具有更新租户级消息通知的权限。
- 通过服务入口方式访问CodeArts Check服务首页。
- 依次选择。参考表4 租户级消息配置配置消息通知。
表1 租户级消息配置 通知类型
Webhook URL
密钥
事件类型
@user_id
企业微信
参考1获取。
不涉及。
设置任务排队时发送通知。
默认勾选且不可取消。
输入被@成员的企业微信user_id,多个user_id之间使用“,”隔开,长度不超过1024个字符。
钉钉
输入钉钉机器人Webhook地址,长度不超过256个字符。
获取钉钉机器人Webhook地址的方式,请参考钉钉开放平台官网。
如果钉钉机器人的安全设置中开启了加签,需输入加签密钥,长度不超过256个字符。
获取钉钉机器人加签密钥的方式,请参考钉钉开放平台官网。
输入被@成员的钉钉user_id,多个user_id之间使用“,”隔开,长度不超过1024个字符。
飞书
输入飞书机器人Webhook地址,长度不超过256个字符。
获取飞书机器人Webhook地址的方式,请参考飞书开放平台官网。
如果飞书机器人的安全设置中开启了加签,需输入加签密钥,长度不超过256个字符。
获取飞书机器人加签密钥的方式,请参考飞书开放平台官网。
输入被@成员的飞书user_id,多个user_id之间使用“,”隔开,长度不超过1024个字符。
配置代码检查任务消息通知
- 访问CodeArts Check服务首页。
- 进入代码检查页面,在任务列表中,单击任务名称。
- 进入“代码检查详情”页面,选择“设置 > 通知管理”。
- 根据需要开启或关闭事件类型的通知状态。
- 选择“钉钉”,参考表2配置参数。
表2 配置钉钉 配置项
是否必填
说明
Webhook URL
是
输入钉钉机器人Webhook地址,长度不超过256个字符。
获取钉钉机器人Webhook地址的方式,请参考钉钉开放平台官网。
密钥
否
如果钉钉机器人的安全设置中开启了加签,需输入加签密钥,长度不超过256个字符。
获取钉钉机器人加签密钥的方式,请参考钉钉开放平台官网。
事件类型
是
勾选事件类型。
- 全部:所有事件均发送通知。
- 门禁通过:仅门禁通过的事件发送通知。
- 门禁不通过:仅门禁未通过的事件发送通知。
通知内容
是
勾选需要通知内容,包括检查结果,门禁结果,问题数,跳转链接,执行人和完成时间。
@user_id
否
输入被@成员的钉钉user_id,多个user_id之间使用“,”隔开,长度不超过1024个字符。
- 配置完成后,单击“保存”。
- 将“钉钉”开关设置为
状态。
当开关状态为“开启”且任务运行结果满足事件类型设置集时,代码检查服务会发送消息到指定的钉钉群并@到指定用户。
- 在企业微信群群里添加群机器人。(以手机客户端为例,详细指导请参考如何设置群关系机器人。)
- 运行企业微信客户端,选中需要接受消息推送的群聊,单击右上角三个点按钮。
- 单击“群机器人”。
- 单击“添加”。
- 单击“新建”。
- 填写机器人名字,单击“添加”。
- 单击Webhook文本框旁的“复制”获取企业微信Webhook地址。
- 在代码检查任务中配置企业微信群通知服务。
- 选择“企业微信”,参考表3配置参数。
表3 配置企业微信 配置项
是否必填
说明
Webhook URL
是
填写步骤1中获取到的Webhook地址。长度不超过256个字符。
事件类型
是
勾选事件类型。
- 全部:所有事件均发送通知。
- 门禁通过:仅门禁通过的事件发送通知。
- 门禁不通过:仅门禁未通过的事件发送通知。
通知内容
是
勾选需要通知内容,包括检查结果,门禁结果,问题数,跳转链接,执行人和完成时间。
@user_id
否
输入被@成员的企业微信user_id,多个user_id之间使用“,”隔开,长度不超过1024个字符。
- 配置完成后,单击“保存”。
- 将“企业微信”开关设置为
状态。
当开关状态为“开启”且任务运行结果满足事件类型设置集时,代码检查服务会发送消息到指定的企业微信群并@到指定企业微信名。
- 选择“企业微信”,参考表3配置参数。
- 选择“飞书”,参考表4配置参数。
表4 配置飞书 配置项
是否必填
说明
Webhook URL
是
输入飞书机器人Webhook地址,长度不超过256个字符。
获取飞书机器人Webhook地址的方式,请参考飞书开放平台官网。
密钥
否
如果飞书机器人的安全设置中开启了加签,需输入加签密钥,长度不超过256个字符。
获取飞书机器人加签密钥的方式,请参考飞书开放平台官网。
事件类型
是
勾选事件类型。
- 全部:所有事件均发送通知。
- 门禁通过:仅门禁通过的事件发送通知。
- 门禁不通过:仅门禁未通过的事件发送通知。
通知内容
否
勾选需要通知内容,包括检查结果,门禁结果,问题数,跳转链接,执行人和完成时间。
@user_id
否
输入被@成员的飞书user_id,多个user_id之间使用“,”隔开,长度不超过1024个字符。
- 配置完成后,单击“保存”。
- 开关设置为
状态。
当开关状态为“开启”且任务运行结果满足事件类型设置集时,代码检查服务会发送消息到指定的飞书用户。