Slack を活用して GitHub でのタスク対応漏れを防ぐ GitHub Actions

通知内容

以下が全ての通知タイプで、これ以外の種類は届かないようになっています。

全てのユーザー

• PR もしくは、Issue でメンションを受け取った時
  

レビュアー

• レビューリクエストを受け取った時
  

デベロッパー

• レビューをリクエストした時
  
• レビュー結果が返ってきた時
  • Approved
    
  • Requested changes
    
  • Commented
    
• 作成した PR がマージされた時
  

設定方法

まず、導入したい Workspace に Slack App を作成し、それの OAuth Access Token を action に渡してあげることで、実行できるようにします。

Slack App を作成する

以下の手順で作成します。

1. Slack の Your Apps ページ に移動する
2. Create New App をクリックし、From scratch を選択する
   
3. GitHub Notification 等を App Name に入力し、Workspace を選択後に Create App をクリックする
   
4. Add features and functionality から、Permissions をクリックする
   
5. Scopes の Bot Token Scopes から、chat:write を選択する
   
6. Basic Information へ戻り、Install to Workspace をクリックする
   
7. Allow をクリックする
   
8. OAuth & Permissions ページで、 Bot User OAuth Token をコピーする
   

GitHub レポジトリに action ファイルと 設定ファイルを用意する

以下の 2 点を用意してください。
action ファイルはそのままコピーで問題ありません。
userlist ファイルは、環境に合わせて編集してください。

1. .github/workflows/notify-slack.yml

   name: GitHub Notification
   
   on:
     pull_request:
       types: [review_requested, closed]
     pull_request_review:
       types: [submitted]
     issue_comment:
     pull_request_review_comment:
   
   jobs:
     notify:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v2
   
         - uses: ken-matsui/notify-[email protected]
           with:
             slack_oauth_access_token: ${{ secrets.SLACK_OAUTH_ACCESS_TOKEN }}
   

2. .github/userlist.toml

   [[users]]
   github = "ken-matsui"
   slack = "UXXXXXXXXXX"
   
   [[users]]
   github = "ken-matsui-2"
   slack = "UXXXXXXXXXX"
   

github は、GitHub の User ID を入力し、slack は、Slack の User ID を入力します。
それを 1 つのユーザーとして解釈します。

Slack の User ID の取得方法は以下のリンクが参考になります。