GitHubでコード品質を向上！プルリクエスト作成時にSlackへ自動通知する方法

ステップ1：GitHubとSlackをマイアプリ登録

GitHubとSlackをYoomに接続するマイアプリ登録を行います。
最初にマイアプリ登録を行うことで、自動化設定を簡単に行うことができます。

まず、GitHubのマイアプリ登録を行ってください。
Yoom画面左側の「マイアプリ」→「新規接続」をクリックします。

アプリ一覧と検索欄が表示されるので、どちらかを活用してGitHubを選択します。
以下の画面で必要情報を入力し、「Sign in」をクリックします。

これで、GitHubマイアプリ連携が完了します。

次に、Slackのマイアプリ登録を行います。
先ほどと同様に、Slackをアプリ一覧から探すか、検索してください。

ワークスペースの「Slack URL」を入力し、「続行する」をクリックします。

以下の画面でアクセス権限を付与します。「許可する」をクリックしてください。

これで、Slackのマイアプリ連携が完了します。

両方のマイアプリ登録が完了すると、GitHubとSlackがマイアプリに表示されます。

ステップ2：テンプレートをコピー

次に、フローボットのテンプレートを使用して設定を進めましょう。
Yoomにログインし、以下のバナーの「試してみる」をクリックしてください。

「テンプレートがコピーされました！」と表示されるので、「OK」をクリックすることでコピーが完了します。

ステップ3:GitHubのトリガー設定

GitHubのトリガーを設定します。「プルリクエストが作成されたら」をクリックしてください。

‍

「GitHubと連携するアカウント情報」を確認してください。
タイトルは自由に変更できますが、トリガーアクションはそのままで「次へ」をクリックしてください。

続いて、APIの設定をします。
「トリガーの起動間隔」は5分、10分、15分、30分、60分の間隔で起動間隔を選択できます。
プランによって最短の起動間隔が異なりますので、ご注意ください。

「リポジトリ所有者」と「リポジトリ名」は任意で設定してください。

設定後、「テスト」をクリックしてください。
テストを実行し、アウトプットに情報が表示されたことを確認して「保存する」をクリックしてください。

ステップ4：Slackのアクション設定

次に、Slackのアクションを設定します。「チャンネルにメッセージを送る」をクリックしてください。

次に、「Slackと連携するアカウント情報」を確認してください。
タイトルは自由に変更できますが、実行アクションは設定済みとなっています。

「API接続設定」を行います。
「投稿先のチャンネルID」は候補から選択してください。

「メッセージ」には、通知内容を任意で設定してください。
「アウトプット」から、取得した情報を入力できます。‍

設定後、「テスト」をクリックし、「テスト成功」と表示されたら「保存」をクリックしてください。

ステップ5：GitHubとSlackの自動化の動作確認

最後に「トリガーをON」をクリックすると、自動化の設定は完了です。
これで、GitHubでプルリクエストが作成されたら、自動でSlackに通知されます。

今回使用したテンプレートはこちらです。

GitHubでプルリクエスト更新後、コメントを追加しSlackに通知する方法

まずは、GitHubでプルリクエストが更新された後にコメントを追加して、Slackに通知する設定です。

以下のテンプレートをコピーしてください。

コピーが完了したら設定を進めていきます。

マイアプリ登録からGitHubのトリガー設定までは前述と同様のステップなので、そのあとの設定から説明していきます。

分岐条件の設定

分岐を設定します。「分岐│プルリクエストの作成か更新かを判別」をクリックしてください。
※分岐はミニプラン以上のプランでご利用いただける機能（オペレーション）となっております。
フリープランの場合は設定しているフローボットのオペレーションはエラーとなりますので、ご注意ください。
ミニプランなどの有料プランは、2週間の無料トライアルを行うことが可能です。
無料トライアル中には制限対象のアプリや機能（オペレーション）を使用することができます。

タイトルは自由に変更できます。
「分岐対象のアウトプット」は以下のように設定してください。

「分岐条件」は「アウトプット」から取得した情報を入力してください。
「＋分岐条件を追加」から、条件を追加できます。

設定後、「保存する」をクリックしてください。

コメント追加設定

コメントを追加する設定を行います。「Issue・Pull Requestにコメントを追加」をクリックしてください。

「GitHubと連携するアカウント情報」を確認してください。
タイトルは自由に変更できますが、トリガーアクションはそのままで「次へ」をクリックしてください。

APIの設定をします。
「リポジトリオーナー」と「リポジトリ名」は任意で設定してください。

「コメント内容」には、追加するコメントの内容を任意で設定してください。
「アウトプット」から、取得した情報を入力できます。

設定後、「テスト」をクリックしてください。
テストを実行し、アウトプットに情報が表示されたことを確認して「保存する」をクリックしてください。

Slackに通知する設定は前述と同様の設定のため、そちらをご参照ください。

GitHubでプルリクエストにコメントが作成されたら、Slackに通知する方法

次に、GitHubでプルリクエストにコメントが作成されたら、Slackに通知する設定です。

以下のテンプレートをコピーしてください。

コピーが完了したら設定を進めていきます。

マイアプリ登録からGitHubのトリガー設定までは前述と同様のステップなので、そのあとの設定から説明していきます。

分岐条件の設定

分岐を設定します。「分岐│コメントの対象がIssueかPull Requestか判別」をクリックしてください。
※分岐はミニプラン以上のプランでご利用いただける機能（オペレーション）となっております。
フリープランの場合は設定しているフローボットのオペレーションはエラーとなりますので、ご注意ください。
ミニプランなどの有料プランは、2週間の無料トライアルを行うことが可能です。
無料トライアル中には制限対象のアプリや機能（オペレーション）を使用することができます。

タイトルは自由に変更できます。
「分岐対象のアウトプット」と「分岐条件」は以下のように設定してください。
「＋分岐条件を追加」から条件を追加できます。

‍

設定後、「保存する」をクリックしてください。

Slackに通知する設定は前述と同様の設定のため、そちらをご参照ください。

GitHubを使ったその他の自動化の例

他にもGitHubを使った自動化の例がYoomにはたくさんあるので、いくつか紹介します。

1.Slackでメッセージが投稿されたらGitHubでIssueを作成するフロー‍

この連携によって、Slackでメッセージが投稿されたらGitHubでIssueを作成できます。
これにより、チャット内容を基にIssueを作成でき、ヒューマンエラーの防止につながります。

2.GitHubでIssue作成後、AI解析で不足情報をChatworkに通知するフロー

この連携によって、GitHubでIssue作成後、AI解析で不足情報をChatworkに通知できます。
これにより、手動での確認作業が不要となり、円滑な業務進行が見込めます。

3.Googleフォームの添付ファイルをOCRして、GitHubでIssueを作成するフロー

この連携によって、Googleフォームの添付ファイルをOCRして、GitHubでIssueを作成できます。
これにより、手入力の手間を削減でき、業務の生産性向上が期待できます。

まとめ

GitHubでプルリクエストが作成・更新された際に、自動でSlackに通知するフローを構築することで、チーム内の情報共有が格段にスムーズになるでしょう。
特に、手動で通知を行っていた場合と比べて、作業の抜け漏れがなくなり、開発のスピードも向上するでしょう。
今回は、GitHubでプルリクエストが作成されたら、Slackに通知する方法を紹介しました。
また、プルリクエストのコメントが追加された際にも通知を送る設定も可能なので、適宜カスタマイズして運用できます。

手動での通知作業に時間を取られるのはもったいない。自動化で業務のムダを削減し、より仕事に集中できる環境を整えていきましょう。