背景
GitHubのorganizationの運用について検討していました。
developブランチからmainブランチへPRを作成する際に、
特定の人にPRの内容をレビューして頂きたい事があり、本記事はその方法について調べたものです。
対象の方
- GitHubのorganizationの運用について考えられている方
- タイトルに興味を持った方
やりたい事
PRのレビューをされる方を制御したいです。
GitHubのCODEOWNERSを使えば、PRが作成された際に指定したチームの方にレビューのリクエストが届くようにできそうでした。
方法
1. organization内にリポジトリを作成
2. Branch protection ruleの設定
今回は以下のように設定しました。
Code ownerからのレビューを通らないとマージできないようになります。
3. リポジトリに招待するチームの作成
以下の2チームを作成し、どちらともwrite権限を割り当ててリポジトリに招待しました。
- ソースコードを変更し、PRを作成する役割のチーム
- PRをレビューする役割のチーム
チームを作成した時の設定は以下の通りです。
この際、PRを承認する役割のチームのCode reviewタブから以下のように設定しました。
4. CODEOWNERSファイルの作成
CODEOWNERSファイルを.github/の直下に作成しました。
CODEOWNERSに記載した内容は以下の通りです。
.github/CODEOWNERS
* @testHogeOrganization/testTeam
5. プルリクの作成
developブランチに更新を加え、mainブランチへPRを作成しました。
承認者チームにレビューのリクエストとメールが届いておりました。