🐷

SlackにGithubアプリを連携して通知を受け取りたい

2024/07/22に公開

前書き

こんにちは。小生、築浅エンジニアです。
先日、developpersIO FUKUOKA に参加し、株式会社classmethod様に、Zennのステッカーをいただきました。(かわいい)
それで、参加だけして、記事も書かずにステッカーまでもらっていいのかと考えました。
結論、"いいのです" が!私も、エンジニアコミュニティに、IT業界に少しでもお役に立ちたいと思っておりますので、本投稿から、記事執筆をはじめていこうと思っております。
不慣れなため稚拙な文章になっておりますので、ご容赦くださいませ。。orz

皆さん、Slack使ってますか?
今や業務においてデファクトなコミュニケーションツールとなっているSlackですが、Githubを連携し、IssueやPRコメントなどの通知を受け取れるのをご存知でしょうか?

事例

こんなことないですか?

「Githubの通知はメールで確認してるが、他のメールに埋れて気づかなかった」
「コミュニケーションツールは基本Slackに統一したい」

他にも様々なケースあるかと思いますが、私は大体上記のようなことを考えていました。

救世主が

さすがのSlackさん、Githubなどの、今使っているツールを連携してくれる機能を豊富に揃えておられます!
※詳しくは利用しているツールを Slack に連携させる を参照ください。

そんな中でも、今回は「Githubの通知」受け取りたい!!と私自身が思い、設定をしてみました!

Slack Githubアプリ

主な機能

おおよそ皆さん、issueを作ったりetc... だと思います。
何ができるの? -> 公式を見てください。(土下座)

連携手順

1.インストールする

公式 または、Slackアプリの「アプリを追加する」からインストールをする
※Slackアプリからの方が簡単だった

インストールができると、こんなメッセージが届きます

2.Githubアカウントと連携する

届いたメッセージの「Connect Github account」ボタンを押すと、ブラウザに遷移します。(Githubの認証を行なっているブラウザの場合のみ)
ここで、Githubにログインしていない方は、ログインしてください。

「Connect GitHub Account」ボタンを押すと、連携完了です🥳

...私はこの時点で、全ての通知が来ると勘違いしていました。。
いっこうに通知が来ないな。。と思っていると、なにやらリポジトリを購読しないといけないらしい!
それなら購読しよう!

3. リポジトリの購読設定する

以下ショートカットコマンドを入力し、送信すると購読の設定ができます。

/github subscribe owner/repo

よくあるケース

個人のGithubアカウントを企業(Organizations)に所属させている場合
organizations名/リポジトリ名とすると購読できます。
公式を読んで ownerってなんだよ!と私がなったので念の為

/github subscribe conpany/hoge-app

初期値

購読設定した場合、初期値として以下が設定されます。
issues, pulls, commits, releases, deployments
増減する場合は、 subscribeコマンドに加えて、追加したい機能を記述していくとOKです。

/github subscribe conpany/hoge-app discussions

追加できる機能

issues: issueのオープン/クローズ
pulls: PRの作成/マージ
commits: デフォルトブランチに対するコミット
releases: リリース
deployments: デプロイメントステータスの更新
branches: ブランチの作成/削除
comments: PR・issueのコメント
commits:*: 全ブランチに対するコミット
discussions: ディスカッションの作成/回答
+label:"my label": 指定したラベルのPR・issue・コメント
workflows: GithubActinsの実行結果

まとめ

SlackのGithubアプリのインストールから、購読の設定(以下コマンド)が、簡単にできる方法を記載しました。

/github subscribe conpany/repo

メール通知でやっていた人も、リポジトリの動きをもっと追いたい人も、いろんなケースで使えると思います。

備考

所属企業の全リポジトリを購読するにはリポジトリ名の省略でできるが、なかなかに通知が多くておすすめはしません。。

/github subscribe conpany

必要な通知のみに設定することで、通知を見逃さずに済みます。
オオカミ少年になると見落としリスクがますので、チューニングしながら皆様のスタイルに合う設定をおすすめしております。(エンジニアの腕の見せ所)

Discussion