GitHub PRをSlackに自動通知＆2人レビュー必須にする設定方法

開発チームが大きくなってくると、「PRが上がったことに気づかなかった」「レビューなしでマージされてしまった」といった問題が起きがちです。

今回は、GitHubのPRをSlackに自動通知する方法と、マージ前に必ず2人のレビュー承認を必須にする設定を紹介します。どちらも10分程度で設定できるので、ぜひ試してみてください。

やりたいこと

今回設定するのは以下の2つです。

この2つを組み合わせることで、PRの見落としを防ぎつつ、コードの品質も担保できる仕組みが作れます。

まずはSlackのワークスペースにGitHub公式アプリをインストールします。Slackの「App」から「GitHub」を検索してインストールしてください。

インストール時にGitHub側でアプリの権限設定が求められます。Organization配下のリポジトリを連携する場合は、Organization Ownerの権限が必要になるので注意してください。

もし「You do not have permission to modify this app」というエラーが表示された場合は、Organization Ownerに設定を依頼してください。

GitHubアプリの準備ができたら、通知を受け取りたいSlackチャンネルで以下のコマンドを実行します。

/github subscribe オーナー名/リポジトリ名

これで、issues、pulls、commits、releases、deploymentsの通知がこのチャンネルに届くようになります。

デフォルトだと色々な通知が来て少しうるさいので、PR関連だけに絞りましょう。以下のコマンドで不要な通知をオフにします。

/github unsubscribe オーナー名/リポジトリ名 issues commits releases deployments

これでPRの作成・更新・マージ・クローズの通知だけが届くようになりました。

設定内容を確認したい場合は、以下のコマンドで確認できます。

/github subscribe list

次に、GitHub側でブランチ保護ルールを設定して、2人のレビュー承認がないとマージできないようにします。

GitHubのリポジトリページから、以下の順番で設定画面を開きます。

Settings → Rules → Rulesets → New ruleset → New branch ruleset

まずはRulesetの基本情報を設定します。

項目	設定値
Ruleset Name	main-protection（任意の名前でOK）
Enforcement status	Active

「Target branches」セクションで、保護したいブランチを指定します。

「Add target」をクリックして、「Include default branch」を選択すれば、mainブランチが対象になります。

「Rules」セクションで、「Require a pull request before merging」にチェックを入れます。

チェックを入れると詳細オプションが展開されるので、以下のように設定してください。

項目	推奨設定	説明
Required approvals	2	承認必要人数。今回の要件はこれ。
Dismiss stale pull request approvals when new commits are pushed	ON	承認後に新しいコミットがpushされたら、承認をリセットする
Require approval of the most recent reviewable push	ON	最後にpushした人以外の承認を必須にする（自作自演防止）
Require conversation resolution before merging	ON	レビューコメントがすべて解決されるまでマージ不可