一、功能简介
GitHub 助手是团队开发的实用工具。通过 GitHub 助手,你可以实现 与 GitHub 的结合,可以在 中第一时间获取所有开发动态,让跟踪管理、沟通交流更顺畅。
二、配置流程
1. 设置 Webhook 关联项目与群(项目管理员)
- •项目管理员进入 工作台,在应用列表内找到 GitHub 助手,将GitHub 助手机器人拉入群聊
- • 项目管理员通过 @GitHub 助手发送 get_webhook 命令获取群 Webhook 地址
@GitHub助手 get_webhook
- •群管理员会接收到 Bot 发送的 Webhook 地址(仅群管理员会接收到群的 Webhook 地址,请联系管理员获取)
- •到 GitHub 代码仓库选择 Settings 页面添加 Webhook 地址
- •选择 Webhooks 页面,点击 Add webhook 进行地址添加
- •粘贴前面在 中获取的 Webhook 地址,选择 application/json 选项,设置 Send me everything 后,点击 Add webhook
- •添加完成后会在项目群收到成功通知,机器人配置完成
2. 绑定 GitHub 账号(个人用户)
- •从 移动端工作台搜索 GitHub 小助手程序,进入 GitHub 助手小程序,登录并授权
- •完成上述配置步骤,即可在 中通过Bot收到该项目的 Pull Request、Issue 事件通知和在小程序中查看 Pull Request、Issue 详情
三、使用方法
1. Bot
- •获取帮助
@Github 助手 help
- •获取 Webhook 地址
@GitHub 助手 get_webhook
- •重置 Webhook 地址
@GitHub 助手 reset_webhook
2. 小程序
可在小程序中查看并修改项目情况
- •在工作台界面打开 GitHub 小程序,可查看代码仓库 Pull Requests 和 Issue 列表详情信息
- •在 Pull Request 的详情页面,点击 Label 可对单个的项目设置标签
- •选择 Assignee 可设置经办人
- •选择 Comment 快速评论互动
3. 消息卡片
在设置了 Webhook 的代码仓库上触发事件会通过消息卡片发送到项目群。
- •在 移动端通过点击查看详情跳转到小程序应用内查看详情
- •在 电脑端点击查看详情则跳转到 GitHub 对应的网页
目前消息卡片支持的事件包括:
- •成功设置 Webhook
- •创建、关闭和打开 Issue
- •编辑和评论 Issue
- •创建、关闭和打开 Pull Request
- •编辑 Pull Request
- •代码合入