🔔 [GitHub Actions] GitHub Discussions와 Slack 연동하기

협업을 하면서 문서화를 위해 GitHub Discussions를 사용하기로 했다.

 

기존에는 notion을 주로 사용했지만,

GitHub에 이미 organization이 존재하는 상황에서 플랫폼을 하나더 늘리기 보다는 통일하는 것이 좋다는 판단이었다.

 

Slack에 있는 GitHub 앱에서 간단한 명령어 한 줄이면 `issues`, `pulls`, `commit`등의 알림을 받을 수 있지만,

Discussions에 새 글이 올라왔을 때 알림을 받을 수 있는 명령어는 없다. 😭

 

알아보니 GitHub Actions와 Web Hook을 사용하여 Slack과 연동할 수 있다고 하여 직접 해보려고 한다!

 

1. GitHub Actions 워크플로우 설정

1) GitHub 레포지토리에서 `.github/workflows` 디렉토리 하위에 `discussioins-notification.yml`과 같은 이름의 YAML 파일을 생성한다.

2) 아래와 같이 GitHub Actions 워크플로우를 설정한다.

name: GitHub Discussions Notification

on:
  discussion:
    types: [created]
  discussion_comment:
    types: [created]

jobs:
  notify_slack:
    runs-on: ubuntu-latest
    steps:
      - name: Check out code
        uses: actions/checkout@v2

      - name: Send notification to Slack
        env:
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
        run: |
          MESSAGE="A new discussion has been created: ${{ github.event.discussion.html_url }}"
          curl -X POST -H 'Content-type: application/json' --data "{'text':'$MESSAGE'}" $SLACK_WEBHOOK_URL

위에서는 새로운 토론이 생성되었을 때와 댓글이 달렸을 때 알림이 오도록 했다.

다양한 event trigger와 types를 확인하려면 아래 공식 문서를 참고하자.

 

https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#discussion

Events that trigger workflows - GitHub Docs

 

2. Slack Incomming Webhooks 설정

1) Slack 앱 디렉토리에서 `incoming`으로 검색하여 아래 "Incoming WebHooks`를 설치한다.

2) Incomming Webhook을 생성한 후, Webhook URL을 복사해둔다.

(이 URL은 GitHub Actions에서 Slack에 알림을 보내는데 사용된다.)

 

 

3. GitHub Secrets 설정

1) GitHub 저장소의 Settings > Secrets and variables > Actions 섹션으로 이동하여 `New Repository Secret`을 클릭한다.

2) Name은 `SLACK_WEBHOOK_URL`로 설정하고, Secret에는 이전에 복사해둔 Slck Incoming Webhook URL을 붙여넣는다.

(이 Secret은 GitHub Actions 워크플로우에서 사용된다.)

 

 

완료

이제 새로운 GitHub Discussions 글이 등록되거나 댓글이 달렸을 때 Slack으로 알림을 받아볼 수 있다! 🎉

 

참고 자료

[Git] Github Action Workflow 작성법