Github Actionsを利用してReviewer全員のApprovedを必須にする

2023-04-22

Tech

Github Actions

/

Renovate

指定したレビュワー全員に見てほしい場合、常に見てほしい人数が固定であるならば、Github のブランチプロテクションを利用すれば良い。一方、PR によって見てほしい人数が異なる場合は、ブランチプロテクションでは制御出来ない。

「コメントで指摘した内容などが修正されていないにも関わらず他の人がマージしてしまう」という相談をされた際に考えた内容を元に、Github Actions を利用して Reviewer 全員の Approved を必須にする方法を紹介する。

GitHub Script を利用してレビューの状態を取得する#

Github Actions では、actions/github-scriptを利用することで octokit を利用して Github API を叩くことができる。そこでまず手元で octokit を利用してレビュー状態を取得するスクリプトを書いた。

1
const { data: pull_request } = await github.rest.pulls.get({
2
  owner: context.repo.owner,
3
  repo: context.repo.repo,
4
  pull_number: context.payload.pull_request.number,
5
});
6

7
if (pull_request.requested_reviewers.length > 0) {
8
  throw new Error("There are reviewers who have not reviewed.");
9
}
10

11
const { data: reviews } = await github.rest.pulls.listReviews({
12
  owner: context.repo.owner,
13
  repo: context.repo.repo,
14
  pull_number: context.payload.pull_request.number,
15
});
16

17
console.log(reviews);

レビューをフィルタリングする#

レビューを一覧で取得すると、そのまま使うには次の 2 つの問題があると分かる。

自分自身のレビューも含まれている。
同一人物による複数回のレビューが全て含まれている。

そこで、これをフィルタリングする必要がある。

自分自身の除外#

次のようにして PR を作成した人物を除外できる。

1
const reviewsWithoutAuthor = reviews.filter((review) => {
2
  return review.user.login !== context.payload.pull_request.user.login;
3
});

ステータスの確認#

レビューのステータスは、単純に最新の状態を取得するだけでは不十分である。次のことを考慮する必要がある。

CHANGE_REQUESTED と APPROVED は現在の状態を上書きする。
COMMENTED は、CHANGE_REQUESTED と APPROVED を上書きできない。

次のようにしてステータスを確認できる。

1
/**
2
 * @type {{[reviewerName: string]: "APPROVED" | "CHANGES_REQUESTED" | "COMMENTED"}}
3
 */
4
const reviewStatus = reviewsWithoutAuthor.reduce((acc, review) => {
5
  if (review.state === "CHANGES_REQUESTED" || review.state === "APPROVED") {
6
    acc[review.user.login] = review.state;
7
  }
8
  if (review.state === "COMMENTED" && acc[review.user.login] === undefined) {
9
    acc[review.user.login] = review.state;
10
  }
11
  return acc;
12
}, {});

全員が Approved しているかどうかは次のようにすればいい。

1
const allApproved = Object.values(reviewStatus).every((state) => {
2
  return state === "APPROVED";
3
});

Resusable workflow として作る#

以上のスクリプトを利用して、レビューの状態を取得し、全員が APPROVED であるかを確認することができる。

全てをまとめて Resusable workflow として作成すると次のようになる。

1
name: Approved Checker
2
on: workflow_call
3

4
jobs:
5
  main:
6
    runs-on: ubuntu-latest
7
    steps:
8
      - name: Get pull request reviews
9
        uses: actions/github-script@v6
10
        with:
11
          script: |
12
             const { data: { requested_reviewers } } = await github.rest.pulls.get({
13
              owner: context.repo.owner,
14
              repo: context.repo.repo,
15
              pull_number: context.payload.pull_request.number
16
            });
17

18
            if(requested_reviewers.length > 0) {
19
              throw new Error('There are reviewers who have not reviewed.');
20
            }
21

22
            const { data: reviews } = await github.rest.pulls.listReviews({
23
              owner: context.repo.owner,
24
              repo: context.repo.repo,
25
              pull_number: context.payload.pull_request.number
26
            });
27

28
            const reviewsWithoutAuthor = reviews.filter((review) => {
29
              return review.user.login !== context.payload.pull_request.user.login;
30
            });
31

32
            if(reviewsWithoutAuthor.length === 0) {
33
              throw new Error('No pull request reviews have been submitted.');
34
            }
35

36
            const reviewStatus = reviewsWithoutAuthor.reduce((acc, review) => {
37
              if (review.state === "CHANGES_REQUESTED" || review.state === "APPROVED") {
38
                acc[review.user.login] = review.state;
39
              }
40
              if (review.state === "COMMENTED" && acc[review.user.login] === undefined) {
41
                acc[review.user.login] = review.state;
42
              }
43
              return acc;
44
            }, {});
45

46
            const allApproved = Object.values(reviewStatus).every(state => {
47
              return state === "APPROVED";
48
            });
49

50
            if (!allApproved) {
51
              throw new Error('Not all pull request reviews have been approved.');
52
            }

次のようにして利用すれば、PR を操作する度に走らせてレビューの状態を確認できる。

1
name: Approved Checker
2

3
on:
4
  pull_request:
5
    types:
6
      [opened, reopened, synchronize, review_requested, review_request_removed]
7
  pull_request_review:
8
    types: [submitted, edited, dismissed]
9

10
jobs:
11
  check_review_status:
12
    uses: org_name/workflow_repository_name/.github/workflows/approved-checker.yml@main

誰か 1 人にだけ見てほしい場合#

例えば、ラベルなどを利用して次のように制御できる。

1
name: Approved Checker
2
on: workflow_call
3

4
jobs:
5
  main:
6
    runs-on: ubuntu-latest
7
    if: contains(github.event.pull_request.labels.*.name, 'or-review') == false
8
    steps:
9
      - name: Get pull request reviews
10
        uses: actions/github-script@v6

Reusable Workflow を利用する側ではラベルの変更をトリガーにする。

1
on:
2
  pull_request:
3
    types:
4
      [
5
        opened,
6
        reopened,
7
        synchronize,
8
        review_requested,
9
        review_request_removed,
10
        labeled,
11
        unlabeled,
12
      ]