摘要：用技術來解決 PM 枯燥的 approval pr 工作，本文將闡述如何自動化獲取 GitHub Organization 下各個 repo 待 merge 的 pull requests 並通知相關人員，告別每日的手動操作。

![釘釘機器人](https://www-cdn.nebula-graph.com.cn/nebula-blog/ding-ding-chat-bot.png)

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

- 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 的實現方式，如果你使用其他通訊工具，實現原理是相通的。

## 配置訊息接收

### 配置釘釘群機器人

1. 開啟機器人管理頁面。以 PC 端為例，開啟 PC 端釘釘，點選“群設定” => “智慧群助手” => “新增機器人”。

![dignding-chat-bot](https://www-cdn.nebula-graph.com.cn/nebula-blog/dignding-chat-bot.png)

2. 點選“新增機器人”，選擇“自定義”

![釘釘機器人](https://www-cdn.nebula-graph.com.cn/nebula-blog/釘釘機器人.png)

本例的“安全設定”使用自定義關鍵詞的方式，之後給機器人所傳送的訊息中必須包含此處設定的關鍵詞。

3. 點選“完成”，獲取 Webhook

詳細的釘釘 bot 配置文件可參見官方文件：[https://ding-doc.dingtalk.com/doc#/serverapi2/qf2nxq/26eaddd5](https://ding-doc.dingtalk.com/doc#/serverapi2/qf2nxq/26eaddd5)

### 配置 Slack bot

- 建立一個 app（連結：[https://api.slack.com/apps](https://api.slack.com/apps)），設定 App Name，選擇目標 Slack Workspace
- 在左側欄中選擇 “Basic Information” => “Add features and functionality” 選在 “Bots”

![slack-bot](https://www-cdn.nebula-graph.com.cn/nebula-blog/slack-bot.png)

- 在左側欄中選擇 “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](https://slack.com/intl/en-cn/help/articles/115005265703-Create-a-bot-for-your-workspace#add-a-bot-user)

## 配置 Github 獲取 Personal Access Tokens

生成 Token，賦予相應許可權。在此例中，讀取了 Organization 下所有 Public 和 Private Repos，需要勾選 repo。

![generate-github-tokens](https://www-cdn.nebula-graph.com.cn/nebula-blog/generate-github-tokens.gif)

詳細 GitHub Token 配置步驟參見官方文件：[https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)

## 程式碼說明

### 獲取 Github 待 merge pr

[PyGithub](https://github.com/PyGithub/PyGithub) 提供了訪問 Github V3 API 的功能，可以讓你用程式碼去實現 GitHub 上的操作，可透過 `pip install pygithub` 進行安裝。

```
FILTER_TEMPLATE = "repo:{org}/{repo} is:pr is:open review:approved"

class GithubPrList:

@property
    def gh(self):
        return self._gh

@property
    def org(self):
        return self._org

FILTER_TEMPLATE = "repo:{org}/{repo} is:pr is:open review:approved"

def __init__(self,
                 org,
                 repo,
                 login_or_token,
                 password=None,
                 timeout=DEFAULT_CONNECT_TIMEOUT,
                 retry=None,
                 ):
        """
        :param org: string
        :param repo: string
        :param login_or_token: string，token or username
        :param password: string
        :param timeout: integer
        :param retry: int or urllib3.util.retry.Retry object
        """
        #例項化對 Github API v3 的訪問
        self._gh = Github(login_or_token=login_or_token,
                          password=password,
                          timeout=timeout,
                          retry=retry)
        self._org = org
        self._repo = repo

def getIssues(self,
                   		 filter=None,
                       sort=DEFAULT_PR_SORT,
                       order=DEFAULT_ORDER,
                       ):
        """
        :param filter: string
        :param order: string ('asc', 'desc')
        :param sort: string('comments', 'created', 'updated')
        :rtype :class:`List` of :class:`PrList2.PrElement`
        """
        if not filter:
        		#生成查詢的 filter，指定org/repo 下已經approved 的pr
            filter = self.FILTER_TEMPLATE.format(org=self._org,
                                                 repo=self._repo)
        #查詢
        issues = self._gh.search_issues(filter, sort, order)
        prList = []

for issue in issues:
            prList.append(PrElement(issue.number, issue.title, issue.html_url))

return prList
```

函式說明：

- `__init__` 支援使用 username/ password 或者 token 去例項化對 GitHub API V3的訪問（英語是 instantiate to access the Github API v3）。
- 在 Github 中，pull requests 也是 issues，`getIssues()` 函式允許使用者可使用預設條件（`repo:{org}/{repo} is:pr is:open review:approved`）查詢指定 org/repo 下狀態是 Approved 的 pull requests，也就是待 merge 的 prs。其中:

| Qualifier | 說明 |
| --- | --- |
| 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 的篩選條件，使用示例：

```
filter = "repo:myOrg/myRepo is:pr is:open review:approved"
GithubPrList(self.org, 
							self.repo, 
              self.token).getIssues(filter)
```

更多篩選條件，請參見官方文件：[https://help.github.com/en/github/searching-for-information-on-github/searching-issues-and-pull-requests](https://help.github.com/en/github/searching-for-information-on-github/searching-issues-and-pull-requests)

### 傳送訊息

#### 傳送釘釘訊息

DingtalkChatbot 對釘釘訊息型別進行了封裝。本文使用此工具傳送待 merge 的 pr 到釘釘群，可透過 `pip install DingtalkChatbot` 安裝 DingtalkChatbot。

```
from dingtalkchatbot.chatbot import DingtalkChatbot

webhook = "https://oapi.dingtalk.com/robot/send?access_token=xxxxxxxxxx"
atPerson = ["123xxx456","123xxx678"]

xiaoding = DingtalkChatbot(webhook)
xiaoding.sendMsg({自定義關鍵詞} + "上文中的 pr list", atPerson)
```

將訊息傳送到釘釘群，此處需要用到上文中的釘釘群機器人的 Webhook 和自定義的關鍵詞。

#### 傳送 slack 訊息

[Python slackclient](https://github.com/slackapi/python-slackclient) 是 Slack 開發的官方 API 庫，能夠從 Slack 頻道中獲取資訊，也能將資訊傳送到Slack頻道中，支援 Python 3.6 及以上版本。可透過 `pip3 install slackclient` 進行安裝。

```
from slack import WebClient
from slack.errors import SlackApiError

client = WebClient(token={your_token})

try:
    response = client.chat_postMessage(
        channel='#{channel_name}',
        text="Hello world!")
    assert response["message"]["text"] == {pr_list}
except SlackApiError as e:
    # You will get a SlackApiError if "ok" is False
    assert e.response["ok"] is False
    assert e.response["error"]  # str like 'invalid_auth', 'channel_not_found'
    print(f"Got an error: {e.response['error']}")
```

用上文配置的 token 替換此處的 {your_token}，替換 {channel_name}，將 pr_list 傳送給目標 channel。

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

![dingding-chat-bot-demo](https://www-cdn.nebula-graph.com.cn/nebula-blog/dingding-chat-demo.png)

本文中如有任何錯誤或疏漏，歡迎去 GitHub：[https://github.com/vesoft-inc/nebula](https://github.com/vesoft-inc/nebula) issue 區向我們提 issue 或者前往官方論壇：[https://discuss.nebula-graph.com.cn/](https://discuss.nebula-graph.com.cn/) 的 `建議反饋` 分類下提建議 ?；加入 Nebula Graph 交流群，請聯絡 Nebula Graph 官方小助手微訊號：[NebulaGraphbot](https://www-cdn.nebula-graph.com.cn/nebula-blog/nbot.png)

> 作者有話說：Hi，我是 Jude，圖資料 Nebula Graph 的 PM，歡迎大家提需求，雖然不一定都會實現，但是我們會認真評估^ ^

釘釘機器人自動關聯 GitHub 傳送 approval prs

相關文章