コード日進月歩

しんくうの技術的な小話、メモ、つれづれ、など

2023夏時点のGitHubとSlackを連携方法をざっくりまとめる

2023年夏時点での連携方法をまとめる

前提:GitHubアプリをSlackにインストールする

現時点だと簡単にAppを登録することができるので、Slack連携をする。イメージは以下。

Appの選択

なお、App連携はワークスペース全体に関係する部分なので、会社で管理している場合は追加に課題感が内科を問い合わせてから利用すると良いと思います。

連携が終わるとAppのところに GitHub が追加されます。

特定のリポジトリ通知をさせる

特定リポジトリをSlack通知させたい場合は、通知を流したいチャンネルで以下のコマンドを打つ。

/github subscribe {{オーガナイゼーション名}}/{{リポジトリ名}} 

例えば私が所有するブランチだと以下。

/github subscribe shinkufencer/demodemo_demo

なお、リポジトリ側にSlackとの連携がされていない場合は案内の通知がくるのでそれに従って登録する。

成功すると連携できた旨が表示される。

通知が届くようになる

デフォルトでは issues, pulls, commits, releases, deployments の項目のみ通知が来るため、issueのコメントやreview、branchの操作も通知したい場合は

/github subscribe {{オーガナイゼーション名}}/{{リポジトリ名}} {{追加対象}}

で追加できる。issueコメントの通知を追加したい場合は以下

/github subscribe shinkufencer/demodemo_demo comments

コメントがスレッドでつく

追加できる対象はドキュメント参考のこと。

自分自身にまつわることを通知させる

自分自身にまつわることを通知させたい場合はのGitHubのAppから自身のアカウントを連携させます。Connect on GitHub Account をすると連携画面が出てきます。順に進めると最後に連携用のコードが出てくるので、コードをコピペし、Enter Code でコードを入力すると連携が成立します。

連携が成立するとリマインダーの設定ページ で設定ができるようになる。

こちらではOrgnization単位で、どこのSlackのワークスペースで、どう通知させたいかを設定することができる。

大きく2種類あり

  • 定期的なReviewについての通知
  • assignがされたときのPRについての通知
  • リアルタイムで変化のあったことの通知

が設定できる、いずれもSlack上ではGitHubのAppで流れる。

参考リンク