Slack の DM で GitHub のレビュー通知をリアルタイムに受け取る
GitHub で PR のレビューを依頼されたときや、自身の PR が承認(Approved)または変更依頼(Changes Requested)されたときにリアルタイムで Slack に DM で通知が届くと非常に便利です。
/github subscribe
をすることでチャンネルに通知を登録することはできますが、これだと重要な通知を見逃してしまうことも少なくありません。
Slack の GitHub アプリを使うと、特定のイベントが発生したときに GitHub アプリからの DM として通知を受け取ることができます。
自分はいつ設定したのか忘れていて、いつのまにかそうなっていたのですが、これをチーム内の全員で設定しようと思ったところ Slack 連携のリポジトリの README や GitHub アプリの詳細ページを探しても情報が見つからず、困ったので備忘録としてまとめます。
あとから探すと、 DevelopersIO さんの記事で紹介されていました。
前提条件
今回は前提として、以下の条件を仮定しています。
他の条件でどういう見え方になるかまで検証するのが大変そうだったので許してください...
- GitHub の Organizations を使用している
- Slack に GitHub アプリがインストールされている
Scheduled Remindes (Real-time Alerts)
調べてる中で何度か "Scheduled Reminders" という言葉は目にしていたものの、スケジュールされたリマインダーということは毎日決まった時間に教えてくれる機能かな?と勝手に思い込んで無視してしまってました。
この Scheduled Reminders の中に Real-time Alerts というものがあり、それこそがまさに探していたリアルタイム通知でした!
設定方法
設定の流れとしては次のようになります:
- Scheduled Reminders の設定画面 で GitHub Organizations と Slack Workspace を紐づける
- Real-time Alerts を設定する
1. GitHub Organizations と Slack Workspace を紐づける
GitHub の Scheduled Reminders の設定画面にアクセスすると、次の画像のように、自分の所属する GitHub Organizations の一覧が表示されます。
リアルタイム通知を設定したい GitHub Organizations の名前か右側の + アイコンをクリックして、詳細設定画面に移動します。
移動したら、 "Authorize Slack Workspace" をクリックして GitHub アプリを Slack Workspace で認可します。
認可が完了すると、リマインダーを作成できるようになります。
2. Real-time Alerts を設定する
今回はリアルタイム通知を設定するので、 "Days" と "Times" の選択は全て解除して構いません。定期的にいま自分がもっているボールをリマインドしてほしい場合は、こちらも設定しておくと便利かもしれません。
真ん中下あたりにある "Enable real-time alerts" にチェックを入れ、リアルタイム通知がほしいイベントにチェックを入れて "Create reminder" をクリックすると設定完了です!
これで、PR のレビュワーにアサインされたときや自身のレビュー依頼が Approve や Request Changes されたときに GitHub アプリから DM で通知が送られてくるはずです! 🎉
Discussion