通过阅读此文,你可了解如何在飞书上配置 Jenkins CI 助手。
一、功能简介
Jenkins CI 助手是飞书团队开发的实用工具。通过 Jenkins CI 助手,你可以实现飞书与 Jenkins 的结合,可以在飞书中第一时间获取所有开发动态,让跟踪管理、沟通交流更顺畅。
二、配置流程
1. Jenkins 系统地址配置(租户管理员)
飞书租户管理员在管理后台页面启用 Jenkins CI 助手,并在应用管理后台配置企业内部 Jenkins 地址。
进入飞书工作台,在应用列表内找到 Jenkins CI 助手。
点击页面右侧的配置按钮后,点击打开管理后台链接。
点击编辑进入编辑页面进行系统地址配置。
2. Jenkins 插件配置 (Jenkins 系统管理员)
为了支持 Jenkins 通知配置及 Webhook 地址配置等功能,需要安装飞书官方 Jenkins 插件。
2.1 Jenkins 插件安装(本地安装)
2.1.1 下载插件包
2.1.2 安装插件包到 Jenkins
进入系统管理,选择插件管理的 Advanced 界面,通过 Upload Plugin 上传插件。
2.2 Jenkins 插件配置
项目管理员将 Jenkins CI 助手 Bot 加入群聊中,并发送消息:
@JenkinsCI助手 get_webhook
群管理员会接收到 Bot 发送的 Webhook 地址(仅群管理员会接收到群的 Webhook 地址,请联系管理员获取)。
在 Jenkins 中选择 Job 并配置插件及 Webhook 地址,选择Configure进行配置。
构建完成后选择增加构建后步骤,选择Feishu Jenkins Plugin进行通知器配置(仅支持 Freestyle project 模式的 Job)。
粘贴 Webhook 地址并保存。
3. 小程序登录(个人用户)
进入 Jenkins 个人设置页,获取 API Token。
在 Configure 页面选择 Add new Token 添加新 Token。
小程序中填入对应的用户名和 API Token 登录(用户名为 Jenkins 登录用户名,不是 API Token 名称)。
4. Bot 小程序关联(个人用户)
Bot 发送构建结果到指定群,用户通过通知卡片可关注自己的 job。目前小程序中的 job 列表只存放用户所关心的构建任务,来源于用户从 Jenkins 的 bot 消息卡片的点击。
点击查看详情,将构建事件加入到用户的关注 job 后,小程序会自动记录到列表。
三、使用方法
完成 Jenkins CI 助手的设置后,管理员将构建结果发到指定群,群成员通过上述个人用户绑定途径绑定后,即可收到特定关注信息的通知。
1. Bot 绑定
获取 Webhook 地址(仅群管理员可操作)
@Jenkins助手 get_webhook
更新 Webhook 地址(仅群管理员可操作)
@Jenkins助手 reset_webhook
help 命令,获取 bot 命令帮助
@Jenkins助手 help
2. Jenkins 插件
Send URL:配置接收群的 Webhook,可配置多个,通过逗号隔开。
触发通知选项:勾选需要的选项,包含启动构建时通知、构建成功时通知、构建失败时通知和构建中断时通知。
3. 小程序
在 Jenkins 插件端设置 Webhook 地址和触发通知的配置后,在 job 触发构建后将会发送相关通知卡片到关联的群中,卡片通知内容包含任务名称、启动者、构建结果和耗时。