Renovateのレビュワーにチームを指定して運用する

2024年8月16日

Renovateでレビュワーを指定する際、Githubで設定したチームを指定することで、放置される可能性を減らしたり、チームメンバーが変わっても設定を変更する必要がなくなるなどのメリットを受けられる。

Table of Contents

RenovateのPRを放置するケースが散見されたため、各チームをレビュワーに指定する対応を行った。

Renovateのレビュワーにチームを指定する

ユーザーではなく、チームをレビュワーに指定する場合、特殊な記法が必要になる。例えば、my-teamというチームを指定する場合、次のように記述する。

reviewers: [team:my-team]

所属しているユーザーの権限とは別にRepositoriesへのアクセス権限を設定しなければ、レビュワーとしてチームを設定できない。

チームの画面から、Repositoriesタブを選択しアクセス権限を設定する。

Renovateでチームをレビュワーに設定する場合、チームがそのリポジトリへのアクセス権限を持っている確認する必要がある。PRのreviewersから選択できるかで判断するのが簡単だ。

多くの場合、開発者全員や部署単位などでチームが作成されていると思う。その場合、サブチームを作成すると、リポジトリのアクセス権限が引き継がれるため、新規のリポジトリが生えた場合に都度チームに対してアクセス権限を設定する手間を省ける。

サブチームにする場合は、チームを作成する際に、Parent teamから親とするチームを選択すればいい。

チームがレビュワーに設定された場合、所属しているメンバーをレビュワーに自動的に追加する機能がある。

チーム画面のSettingsタブにあるCode reviewの項目から設定できる。

次の設定例では、チームメンバーから交互に4名を選択しレビュワーに自動的に追加する。