GitHub Actionsを利用してレビューとアサインを自動化

要件

今までプルリクエストを作成した時に
レビューの指定とアサインを自身にするということを
手動で行ってました。

この作業をGitHub Actionsで自動化を行いました。

前提条件

レビュアーに複数人指定しているのでGitHubのTeam
機能を利用し、Teamを作成しています。

実装

• リポジトリ/.github/auto_assign.yml

このファイルは、プルリクエストが作成されたときに自動的にレビュアーとアサインを設定するための設定を行います。

addReviewers: true に設定すると、プルリクエストにレビュアーを追加します。
addAssignees: author に設定すると、プルリクエストの作成者をアサインします。
teamReviewers: ここに指定したGitHubのチームがレビュアーとして追加されます。
numberOfReviewers: 追加するレビュアーの数を指定します。0 に設定すると、すべてのレビュアーが追加されます。

# Set to true to add reviewers to pull requests
addReviewers: true

# Set addAssignees to 'author' to set the PR creator as the assignee.
addAssignees: author

# A list of reviewers to be added to pull requests (GitHub user name)
teamReviewers:
  - sre-team

# A number of reviewers added to the pull request
# Set 0 to add all the reviewers (default: 0)
numberOfReviewers: 0

• リポジトリ/.github/workflows/autoreviewer.yml

このファイルは、GitHub Actionsのワークフローを定義します。

name: ワークフローの名前です。
on: ワークフローをトリガーするイベントを指定します。ここでは、プルリクエストが作成されたとき (opened) と
レビューの準備ができたとき (ready_for_review) にトリガーされます。
jobs: 実行するジョブを定義します。
runs-on: ジョブを実行する環境を指定します。ここでは ubuntu-latest を使用しています。
steps: ジョブのステップを定義します。ここでは titenkov/auto-assign-action@v1.2.1 を使用して、
auto_assign.yml の設定に基づいてレビュアーとアサインを自動化しています。

name: 'Auto Assign'
on:
  pull_request:
    types: [opened, ready_for_review]

jobs:
  add-reviews:
    runs-on: ubuntu-latest
    steps:
      - uses: titenkov/auto-assign-action@v1.2.1
        with:
          configuration-path: ".github/auto_assign.yml" # Only needed if you use something other than .github/auto_assign.yml

参考リンク

これらの設定を利用することで、プルリクエストのレビュープロセスを効率化し、
手動での作業を減らすことができます。ぜひ試してみてください。