飞书集成和通知
如果您想在飞书的群组中查看极狐GitLab 项目中的事件变更,如创建议题、流水线故障或关闭合并请求等,您可以将飞书与极狐GitLab 进行集成。
飞书集成
配置飞书
- 在飞书中创建机器人
- 在飞书群组中添加机器人
在飞书中创建机器人:
- 访问 https://open.feishu.cn,进入 飞书开放平台 页面。
- 在右上角,选择 登录,扫描二维码,登录进入您的组织。
- 在右上角,选择 我的后台 > 开发者后台 进入我的后台页面。
- 选择 创建企业自建应用,在弹出的窗口中选择 企业自建应用,填写应用名称和应用描述,选择 确定创建。
- 选择 企业自建应用 列表中您新建的应用的名称,在左侧边栏中选择 凭证与基础信息,在右侧页面中单击 综合信息 旁边的编辑图标,上传应用图标,并记录页面中显示的 App ID 和 App Secret,以便后续使用。
- (可选)在左侧边栏中,选择 成员管理,添加协作人员。
- 在左侧边栏中,选择 应用功能 > 机器人,在右侧页面中打开 启用机器人 开关。
- 在左侧边栏中,选择 权限管理,在右侧页面中的 权限配置 列表中单击 获取与更新群组信息 和 获取与发送单聊、群组消息 最右侧的 开通权限,获取相应权限。
- 在左侧边栏中,选择 应用发布 > 版本管理与发布,在右侧页面中选择 创建版本,按照要求填写 应用版本号、移动端默认的应用功能、PC 端默认的应用功能 和 更新说明,选择 保存。
- 在出现的页面中单击右上角的 申请线上发布。
在飞书开放平台首页的右上角,单击 我的后台 旁边的功能菜单图标,选择 管理后台 进入飞书管理后台页面。在左侧边栏中选择 工作台 > 应用审核。在右侧页面中选择 设置审核规则,您可以查看 自建应用免审规则 下的 开启免审 开关是否开启。如果开启,您在在飞书中创建机器人申请线上发布后,您所创建的版本会自动通过审核,上线发布;如果未开启,在申请线上发布后,您需要在飞书管理后台页面中选择 工作台 > 应用审核,在右侧页面的审核列表中手动审核。
在飞书群组中添加机器人:
- 打开您需要添加机器人的飞书群组,选择右侧边栏中的设置图标。
- 选择 群机器人 > 添加机器人,将您的机器人添加到群组中。
配置极狐GitLab
- 启动极狐GitLab Rails 控制台,在控制台中运行
Feature.enable(:feishu_integration)
,完成飞书特性开关的启用。详情请参见功能标志文档(功能标志为 feishu_integration,15.4 及之后的版本跳过此步骤)。 - 以管理员身份登录极狐GitLab,在左侧边栏中选择 管理中心 > 设置 > 通用。
- 在右侧页面中,选择 飞书集成 右侧的 展开,勾选 启用飞书集成 复选框,并填写 飞书App ID 和 飞书App Secret,选择 保存更改。
- 在左侧边栏中,选择 管理中心 > 设置 > 集成。
- 在右侧页面中,选择 飞书 > 设置,勾选 激活集成 下面的 激活 复选框。
- 在 触发器 下面勾选您想在飞书群组中接收通知的事件类型。如推送、议题和评论等。
极狐GitLab 中需要填写的 飞书App ID 和 飞书App Secret 是在飞书中创建机器人步骤 5 中记录的 App ID 和 App Secret。
至此,您已经完成了飞书和极狐GitLab 集成所需的所有配置工作。
飞书通知
当触发器的以下事件发生时,极狐GitLab 会向您配置成功的飞书群组中发送相关通知。
触发器名称 | 触发事件 |
---|---|
推送 | 向仓库推送新内容。 |
议题 | 创建、更新或关闭议题。 |
私密议题 | 创建、更新或关闭私密议题。 |
合并请求 | 创建、合并或更新合并请求。 |
评论 | 添加评论。 |
私密评论 | 添加私密评论。 |
标签推送 | 向仓库推送新标签。 |
流水线 | 流水线状态发生变更。 |
Wiki 页面 | 创建或更新 Wiki 页面。 |
部署 | 开始或完成部署。 |
告警 | 记录新告警。 |
漏洞 | 记录新漏洞。 |