【Slack】GitHubと連携してPushやPRなどの通知を受け取れるようにしよう

 

SlackとGitHubを連携させることで、

コードの変更やプルリクエストの進捗、新しいイシューの作成などをリアルタイムに通知できます。

 

これによって、チーム全体のコミュニケーションをスムーズにし開発効率が向上します。

では、実際に連携していきましょう！！

 

GitHubと連携するためのアプリをSlackへインストール

 

インストールするアプリのドキュメントは↓です

 

slack.github.com にアクセスして、「Add to Slack」をクリックします

「許可する」をクリックします

Slackが開かれ、AppにGitHubが追加されています。

 

また、GitHubからＤＭが来ています

 

GitHubのアカウントと連携する

 

GitHubアプリに対して下記のメッセージを送ります

 

返ってきたメッセージ内の「Connect GitHub account」をクリックします。

 

WEBブラウザでページが開くため、「Connect GitHub account」をクリックします。

続いてGitHubでSlackを認証していいか聞かれるので、「Authrorize Slack」をクリックします

 

認証コードが発行され、

 

Slackに戻って、このコードをGitHubアプリに送ります

「Enter code」をクリックするとダイアログがでるので

先ほどの認証コードを打ち込みます

 

GitHubとの連携が完了すると新しくメッセージが届きます

 

【必要に応じて】通知用チャンネルを作成する

 

普段やり取りしているチャンネルに通知するとメッセージが流れてしまいます。

特に開発が活発なプロジェクトだとGitHubからの通知が邪魔になってしまうかも。

 

なので、GitHubからの通知用のチャンネルを作成することをオススメします。

チャンネル名にGitHubからの通知ということがわかるといいと思います

 

通知される項目

デフォルトで通知される項目

⇒通知開始したら受け取れる項目。通知オフにもできる。

項目	通知タイミング
issues	issuesのオープン/クローズ
pulls	PRの作成/マージ
commits	デフォルトブランチへのコミット
releases	releasesのpush
deployments	Deployment status の更新

 

デフォルトでは通知されない項目

⇒通知開始しても受け取れない項目。通知オンにする必要がある。

項目	通知タイミング
workflows	GitHub Actions の実行
reviews	PRへのレビュー
comments	issues や PR へのコメント
branches	ブランチの作成/削除
commits:*	すべてのブランチへのコミット
+label:”your label”	指定したラベルを持つissues や PR、コメント
discussions	discussions の作成や回答

 

通知設定

 

通知を受け取るSlackチャンネルに移動し、コマンドを実行します。

 

 

通知の開始/停止

 

 

通知される項目の追加/削除

 

 

動作確認

push

 

push時にはpushとcommitの通知がきます

 

PR作成&コメント

 

PR作成時のスレッドにコメントの内容が通知されます

 

PRマージ

 

マージするとPR作成時のスレッドに通知がきます

 

マージ時にはブランチへのpush通知やマージ元のブランチ削除の通知もきます

 

参考

 

GitHub - integrations/slack: Bring your code to the conversations you care about with GitHub's integration for Slack

Bring your code to the conversations you care about with GitHub's integration for Slack - integrations/slack

github.com

【Slack + GitHub連携】issueコメントやプルリク通知をチャンネルに流して開発効率を加速させる

zenn.dev

GitHubとSlackを連携させて通知を自動化するまでの手順

zenn.dev