GitHub の Slack App の使い方について改めて調べてみた
もう開発ではおなじみだとは思うが GitHub の Slack App を使えば GitHub でのコメントやプルリクエストなどのイベントを Slack のチャンネルに通知することができる.
おそらく殆どのチームが利用しているとは思うがこの GitHub の Slack App について知らなかったことや勘違いしていたことについて今回はまとめてみる.
設定方法
このヘルプセンターの通りに進めれば簡単に設定できる
各種通知の意味について
GitHub の Slack App ではデフォルトで通知を行う機能として下記がある.
- issues (イシュー)
- pulls (プル)
- statuses (ステータス)
- コミット
- deployments (デプロイメント)
- public (パブリック)
「issues」や コミット は何となくわかるが,「statuses」や「public」はどんな通知なのかパット見わからない... 調べようにも先程あげたヘルプセンターに各通知の意味については載っていない...
「ではどうすればわかるのか?」となると思うが下記の紹介ページにある「Learn more about the GitHub and Slack integration」のリンクにアクセスする必要がある. (正直言うと文字が小さくて気が付かなかった..)
するとアクセス先は GtiHub リポジトリで,ここの README に各通知についての説明が記載されている. 通知についての説明は下記にある.
どうやら「statuses」はプルリクエストのステータス(CI の進捗状況など)について,「public」はプライベートリポジトリからパブリックリポジトリに変更した時の通知だということがわかる.
不要な通知は/github unsubscribe
で解除する必要がある
先程記載したが,GitHub の Slack App ではデフォルトで通知を行う機能がある.しかしこの中で不要な通知がある場合は/github unsubscribe
を実行する必要がある.
例えば,「statuses」,「deployments」,「public」が不要な場合は通知しているチャンネルで/github unsubscribe owner/repository statuses,deployments,public
を実行すれば通知を解除できる.
ここに関してはヘルプセンターの「以下のスラッシュコマンドも通知のカスタマイズに便利です。」という項目にサラッと書いてはいる.しかし,私は「/github subscribe 〜
を実行するとそこで指定した通知しかチャンネルに通知されなくなる」と勝手に勘違いしてしまっていた.
まとめと所感
今回はかなり基本ではあるが GitHub の Slack App についてまとめてみた.かなり基本的な内容ではあったが,通知の設定自体はたまに行う程度でその度に忘れてしまっていたので改めてまとめることができて良かった.もう忘れない...はず!!!