钉钉机器人自动关联 GitHub 发送 approval prs

在日常工作中，你是否遇到以下场景：

• Github 存在多个 repo，日常工作中需要一个个地手动筛选大量待 merge 的 pull requests
• 要找出多个 repo 中 ready to review 的 pull requests，要手动筛选，然后一遍又一遍地粘贴复制提交 dev 进行 review #倍感无聊
• 想自动推送 GitHub 待 merge 的 prs，GitHub Webhooks 却没有该 Event
• ……

用技术来解决 PM 枯燥的 approval pr 工作，本文将阐述如何自动化获取 GitHub Organization 下各个 repo 待 merge 的 pull requests 并通知相关人员，告别每日的手动操作。此文主要提供了解决自动发送 approval prs 的思路，并以钉钉群和 Slack 为例，给出了其 Python 的实现方式，如果你使用其他通讯工具，实现原理是相通的。

01配置消息接收

配置钉钉群机器人 

1. 打开机器人管理页面。以 PC 端为例，打开 PC 端钉钉，点击“群设置” => “智能群助手” => “添加机器人”。

2. 点击“添加机器人”，选择“自定义”

本例的“安全设置”使用自定义关键词的方式，之后给机器人所发送的消息中必须包含此处设置的关键词。

3. 点击"完成", 获取 Webhook

详细的钉钉 bot 配置文档可参见官方文档：​​https://ding-doc.dingtalk.com/doc#/serverapi2/qf2nxq/26eaddd5​​

配置 Slack bot 

• 创建一个 app（链接：https://api.slack.com/apps），设置 App Name，选择目标 Slack Workspace
• 在左侧栏中选择 “Basic Information” =>“Add features and functionality”选在“Bots”​

• 在左侧栏中选择“OAuth & Permissions“，在 “Scopes“中点击“Add an OAuth Scope”，添加  chat:write.public 
• 点击“Install App to Workspace“
• 获取 OAuth Access Token

详细的 Slack bot 配置步骤参见官方英文文档：​​https://slack.com/intl/en-cn/help/articles/115005265703-Create-a-bot-for-your-workspace#add-a-bot-user​​

02

配置 Github 获取 Personal Access Tokens

生成 Token，赋予相应权限。在此例中，读取了 Organization 下所有 Public 和 Private Repos，需要勾选 repo。

详细 GitHub Token 配置步骤参见官方文档：​​https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line​​

03代码说明

获取 Github 待 merge pr 

PyGithub 提供了访问 Github V3 API 的功能，可以让你用代码去实现 GitHub 上的操作，可通过  pip install pygithub  进行安装。

函数说明：

•  __init__  支持使用 username/ password 或者 token 去实例化对 GitHub API V3的访问。
• 在 Github 中，pull requests 也是 issues，getIssues()  函数允许用户可使用默认条件（ repo:{org}/{repo} is:pr is:open review:approved ）查找指定 org/repo 下状态是 Approved 的 pull requests，也就是待 merge 的 prs。其中:

• repo:org/repo——查找指定组织 repo 下的projects
• is:pr——查找 pull requests
• is:open——查找 open 的 issues
• review:approved——查找 review 状态是已经 approved，review status 可能取值 none, required, approved， changes requested

用户也可指定 Github issues 的筛选条件，使用示例：

发送消息 

发送钉钉消息

DingtalkChatbot 对钉钉消息类型进行了封装。本文使用此工具发送待 merge 的 pr 到钉钉群，可通过 pip install DingtalkChatbot 安装 DingtalkChatbot。

将消息发送到钉钉群，此处需要用到上文中的钉钉群机器人的 Webhook 和自定义的关键词。

发送 slack 消息

Python slackclient 是 Slack 开发的官方 API 库，能够从 Slack 频道中获取信息，也能将信息发送到Slack频道中, 支持 Python 3.6 及以上版本。可通过  pip3 install slackclient  进行安装。

用上文配置的 token 替换此处的 {your_token}，替换 {channel_name}，将 pr_list 发送给目标 channel。

至此，大功告成！来看看效果

本文转载自公共号Nebula Graph