GitHub Actions からメンション付きで Slack に投稿する

目標

• プルリクエストの作成をトリガーとして GitHub Actions のワークフローを実行し、メンション付きのメッセージを Slack に投稿する

※Slack への通知には、Slack App を作成し、chat.postMessage API を使用します。

前提条件

1. GitHub リポジトリが存在していること
2. 利用できる Slack のワークスペースが存在していること

目次

1. 事前準備
2. Slack App の作成
3. メンバー ID とチャンネル ID の登録
4. ワークフローの作成
5. Slack Bot の招待
6. GitHub Actions でワークフローの実行

事前準備

GitHub Actions のワークフローファイルは以下のディレクトリに作成する必要があります。

.github/workflows

このディレクトリ以外にワークフローファイルを配置しても GitHub Actions は認識しません。
ワークフローファイルは YAML 形式で記述され、ファイル名の拡張子は .yml または .yaml のいずれかを使用します。
以降の手順を実施する前に、プロジェクトのルートディレクトリで以下のコマンドを実行してください。

mkdir -p .github/workflows

Slack App の作成

ワークフローから Slack へ通知するためには Slack App を作成する必要があります。

1. 以下のURLにアクセスします。
https://api.slack.com/apps?new_app=1

2. From a manifest を選択して Continue をクリックします。

3. YAML を選択して以下を入力します。

display_information:
  # Slack App の名前
  name: github-actions-slack-notification
features:
  bot_user:
    # Slack Bot が Slack でメッセージを投稿する時の名前
    display_name: github-actions-slack-notification
oauth_config:
  scopes:
    bot:
      # Slack Botがチャンネルにメッセージ送信する権限
      - chat:write

4. Workspace のセレクトボックスではメッセージを投稿したい Slack のワークスペースを選択します。

5. Create and install をクリックします。

6. 許可するをクリックします。

7. Go to app settings をクリックします。

8. Install App をクリックします。Bot User OAuth Token に表示されている xoxb- から始まる値をコピーします。

9. GitHub のワークフローを作成したいリポジトリの Settings > Secrets and variables > Actions をクリックします。New repository secret をクリックします。

10. 以下を入力して Add secret をクリックします。
Name: SLACK_BOT_TOKEN
Secret: 手順8でコピーした xoxb- から始まる値を貼り付け

11. secrets に SLACK_BOT_TOKENが表示されていることを確認します。

メンバー ID とチャンネル ID の登録

Slack のチャンネルにメンション付きのメッセージを投稿するには、メンション先のメンバー ID と投稿先のチャンネル ID を取得する必要があります。

1. Slack でメンションしたいユーザーのプロフィールを開きます。三点リーダー（︙）のボタンをクリックして「メンバー ID をコピー」をクリックします。

2. GitHub のワークフローを作成したいリポジトリの Settings > Secrets and variables > Actions をクリックします。New repository secret をクリックします。

3. 以下を入力して Add secret をクリックします。
Name: SLACK_USER_ID
Secret: 手順1でコピーしたメンバー ID を貼り付け

4. secrets に SLACK_USER_IDが表示されていることを確認します。

5. Slackでメッセージを投稿したいチャンネルの三点リーダー（︙）をクリックします。「チャンネル詳細」>「チャンネル詳細を開く」の順にクリックします。

6. 画面下のチャンネル ID をコピーします。

7. GitHub のワークフローを作成したいリポジトリの Settings > Secrets and variables > Actions をクリックします。New repository secret をクリックします。

8. 以下を入力して Add secret をクリックします。
Name: SLACK_CHANNEL_ID
Secret: 手順6でコピーしたチャンネル ID を貼り付け

9. secrets に SLACK_CHANNEL_IDが表示されていることを確認します。

ワークフローの作成

1. .github/workflows 配下に以下の内容で slack-notification.yml を作成します。 

name: Notify Slack when a PR created

on:
  # プルリクエストを作成した場合にワークフローを実行する
  pull_request:
    types: [opened]
jobs:
  notify_slack:
    name: Notify Slack
    runs-on: ubuntu-latest
    steps:
      - name: Send the message to Slack
        uses: slackapi/slack-github-action@v4.0.0
        with:
          errors: true
          # https://docs.slack.dev/reference/methods/chat.postMessage/
          method: chat.postMessage
          token: ${{ secrets.SLACK_BOT_TOKEN }}
          payload: |
            channel: ${{ secrets.SLACK_CHANNEL_ID }}
            text: "${{ format('<@{0}>', secrets.SLACK_USER_ID) }} レビューをお願いします。 \nURL: ${{ github.event.pull_request.html_url }}"

2. 作成した slack-notification.yml を master（もしくは main）ブランチにマージします。 

Slack Bot の招待

Slack Bot がチャンネルでメッセージを送信するためには、Slack Bot をチャンネルに招待する必要があります。

1. SLACK_CHANNEL_IDを取得したチャンネルで「メンバーを招待する」をクリックします。

2. github-actions-slack-notification を入力して追加をクリックします。

3. Slack Bot がチャンネルに追加されていることを確認します。

GitHub Actions でワークフローの実行

プルリクエストを作成したら Slack に通知が飛ぶことを確認します。

1. 作業ブランチを作成して push 後にプルリクエストを作成します。

2. プルリクエストの画面でワークフローが正常に完了していることを確認します。

3. Slack Bot からメッセージが投稿されていることを確認します。

4. 通知が届いていることも確認します。