通过阅读此文,你可了解如何在飞书上配置 Travis CI 助手。
一、功能简介
Travis CI 助手是飞书团队开发的实用工具。通过 Travis CI 助手,你可以实现飞书与 Travis CI 的结合,可以在飞书中第一时间获取所有开发动态,让跟踪管理、沟通交流更顺畅。
二、配置流程
1. GitHub 接入 Travis CI(项目管理员)
在使用 Travis CI 助手之前,需要先连接 Travis CI 和 GitHub。
- •进入https://travis-ci.org/,点击 Sign in with GitHub ,按照提示完成授权
- •授权成功之后,打开 GitHub 网站,在 Settings 页面打开 Application 界面后,选择 Authorized OAuth Apps ,确认已安装了 Travis CI APP
这个流程只需要项目管理员完成一次,如果之前已经有授权登录过,可跳过该步骤。
2. 设置 Webhook 关联项目与飞书群(项目管理员)
- •项目管理员将 Travis CI 助手 Bot 加入群聊中,并发送消息:
@TravisCI助手 get_webhook
- •群管理员会接收到 Bot 发送的 Webhook 地址
仅群管理员会接收到群的Webhook地址,请联系管理员获取
- •将 Webhook 地址添加到项目代码库的 .travis.yml 文件中(没有则需要创建 .travis.yml 文件)
notifications:
webhooks:
urls:
- http://your-domain.com/notifications
on_success: always # default: always
on_failure: always # default: always
on_start: never # default: never
on_cancel: always # default: always
on_error: always # default: always
- •在 Travis CI 网站 Settings 页面或 Travis CI 助手小程序中设置项目的 CI 开关(见后续步骤)
3. 登录 Travis CI 助手小程序(个人用户)
- •从飞书移动端工作台进入 Travis CI 助手小程序,登录 GitHub 并授权(也可给组织授权)
- •完成以上配置步骤后,即可在飞书中通过 Bot 收到该项目的构建通知和在小程序中查看构建结果和详情
三、使用方法
1. Bot
- •获取 Webhook 地址
@TravisCI助手 get_webhook
- •更新 Webhook 地址(仅群管理员可操作)
@TravisCI助手 reset_webhook
2. 小程序
- •Bot 发送构建结果到指定群,点击卡片到小程序查看构建详情
- •小程序展示已关注和所有已激活的代码仓库列表,快速查看构建结果和构建详情,可随时关注或取消关注项目
- •小程序同时支持个人仓库和组织仓库的管理,在设置中可以切换展示,并且可以控制项目启用或关闭 Travis CI
3. 消息卡片
3.1 Push 代码到 GitHub 触发构建
- •在仓库项目中 push 代码到 default 分支(一般是 master 分支)
- •等待构建完成,接收到卡片消息,点击卡片内容或构建详情,跳转到小程序对应的构建详情页
- •点击查看代码,跳转到 GitHub 的 CodeReview 页面
3.2 提交 Pull Request 到 GitHub 触发构建
- •登录GitHub,在仓库项目中提交 Pull Request 到 master 分支
- •等待构建完成,接收到卡片消息,点击卡片整体或构建详情,跳转到小程序对应的构建详情页
- •点击查看代码,跳转到 GitHub 的 CodeReview 页面
3.3 在 Travis CI 网站或者调用 API 触发构建
- •等待构建完成,接收到卡片消息,点击卡片整体或构建详情,跳转到小程序对应的构建详情页
- •点击查看代码,跳转到 GitHub 的 CodeReview 页面
3.4 在 Travis CI上设置定时任务触发构建
- •等待构建完成,接收到卡片消息,点击卡片整体或构建详情,跳转到小程序对应的构建详情页
- •点击查看代码,跳转到 GitHub 的 CodeReview 页面