一、功能简介

关于 Jenkins CI

Jenkins 是一个开源的持续集成（CI）工具，用于支持软件项目的构建、部署和自动化。更多详情，请查看 Jenkins 官方文档。

关于 Jenkins CI 助手

Jenkins CI 助手是飞书团队开发的实用工具。通过 Jenkins CI 助手，你可以实现飞书与 Jenkins 的结合，可以在飞书中第一时间获取项目开发动态，让跟踪管理、沟通交流更顺畅。

Jenkins CI 助手主要提供以下功能：

•在飞书群聊中添加配置 Jenkins CI 助手机器人，群聊成员即可收到机器人实时推送的相关 Jenkins 项目构建更新通知

•配置 Jenkins CI 移动端小程序，即可在手机上随时查看你所关心的项目的构建情况

二、操作步骤

1.在群聊中配置机器人

要在飞书群聊中收到 Jenkins 项目的更新提醒，你可将 Jenkins CI 助手机器人添加进群，使用飞书提供的 Jenkins 插件，完成发送提醒所需的 webhook 配置。

1.1 将机器人添加到群

1.1.1 在飞书桌面端上打开你的项目组群聊，添加 Jenkins CI 助手机器人进群（关于添加群机器人的具体步骤，可参考如何在群聊中使用机器人？）。

1.1.2 向机器人发送指令 @Jenkins CI 助手 get_webhook，获取 webhook 地址。

webhook 地址将会以私信的形式发送给群主。在稍后的配置中将会用到该地址，请妥善保存。

备注：你也可以对 Jenkins CI 助手机器人发送以下指令：

•@Jenkins CI Assistant help - 在群聊或单聊中向机器人发送该指令，查看帮助信息

•@Jenkins CI Assistant reset_webhook - （仅群主可发送）在群聊中想机器人发送该指令，以重置并获取新的 webhook 地址

1.2 安装 Jenkins 插件

1.2.1 下载飞书提供的插件包：点此下载。

1.2.2 （仅 Jenkins 管理员可操作）打开 Jenkins，选择 系统管理 > 插件管理 > Advanced。

在 Upload Plugin 中，上传在上一步中下载的插件包。

1.2.3 （仅Jenkins管理员可操作）回到 Jenkins 系统管理页，选择 系统设置。在 Jenkins Location 中，填入 Jenkins URL，格式为http://myServer:8080 ，其中myServer为你的 Jenkins 服务器名称。

1.3 配置 Jenkins 插件

1.3.1 打开相关的 Jenkins 项目，进入 Configure 页面。

注：目前仅支持配置 Freestyle 项目类型。

1.3.2 点击 Add post-build action (构建后操作)，在下拉菜单中选择 Feishu Jenkins Plugin。

1.3.3 将前序步骤中 Jenkins CI 助手机器人发送的 webhook 地址粘贴到 send URL 中，勾选你想收到更新通知的事件类型，然后点击 Save 保存。

1.4 测试验证

你可在 Jenkins 相关项目中触发任一你已勾选的通知事件，以测试目前为止的配置是否正确。如触发一次项目的构建，并确认能够在相关飞书群聊中收到更新通知

更新通知将以消息卡片的形式，由 Jenkins CI 助手机器人推送到群聊。消息卡片上显示了任务名称、启动用户、状态和耗时等信息。

1.5 后续配置

•至此，你已完成了配置 Jenkins CI 助手机器人。该机器人会向所在的群聊中推送更新通知，以便群聊成员们能够及时了解相关 Jenkins 项目的最新动态。

•如果你希望在手机上使用 Jenkins CI 助手的移动端小程序，请继续阅读本文进行配置。你可在该小程序添加你所关注的 Jenkins 项目，无需离开飞书移动端，就能查看到项目的最新构建状态。

2.配置移动端小程序

2.1 前提

在配置和使用 Jenkins CI 助手小程序之前，你的团队管理员前往 Jenkins CI 助手的应用管理后台，填写公司的 Jenkins 服务器地址。

前往飞书管理后台 > 工作台 > 应用列表，进入 Jenkins CI 助手的配置页，点击 打开管理后台。

进入应用的管理后台后，点击编辑，填入公司的 Jenkins 地址后保存。

2.2 登录小程序

通过你的 Jenkins 帐号 API token，在手机上登录 Jenkins CI 助手小程序。

2.2.1 前往你的 Jenkins 个人帐户设置页，点击 系统管理。

2.2.2 为 token 输入适当的名字，然后点击 Generate 。自动生成的 token 字串会在后续的配置中用到，请妥善保存。

2.2.3 在手机上打开飞书客户端，Jenkins CI 助手应用（区别于 Jenkins CI 助手的机器人），输入你的 Jenkins 帐号名和在上一步中获取的 API token，然后点击登录。

2.2.4 至此，当你在移动端查收 Jenkins CI 助手机器人推送到群聊的更新通知时，就能点击 查看详情 按钮，进入移动端小程序查看构建的详情。

2.3 将项目添加到关注列表

你可以在 Jenkins CI 助手小程序的 Jobs 页面中添加想要关注的项目，以便随时在手机上查看项目的构建情况。

在小程序中添加要关注的项目：先在相关群聊中找到该项目的任意一条构建更新通知，点击通知卡片上的 查看详情 按钮以在小程序中打开。这样一来，小程序即将该项目添加为关注对象，将在 Jobs 页中展示所有该项目的构建并持续更新。你可点击相应的构建，查看详情。