CI/CD) Github Actions - Slack 연동

배포 자동화 환경을 구축하면서 Github Actions을 사용하여

Docker 이미지를 빌드하고 ECR에 Push하는 과정을 진행했었습니다.

 

이번에는 그 과정에서 빌드에 실패하거나 오류가 났을 경우에 편리하게 모니터링하기 위해서

업무 협업 툴로 사용되는 Slack과 연동하는 과정을 진행해보겠습니다.

---

1. Slack에 새로운 앱 생성

https://api.slack.com/apps

Slack API: Applications | Slack

1) Create New App -> From Scratch 선택

2) App Name에는 사용할 이름을 입력하고, 그 아래 Pick a workspace to develop your app in에는

알림을 받을 Slack WorkSpace를 선택

 

2. Incoming Webhooks를 활성화 !

참고 ) Webhook이란?

하나의 앱/웹이 다른 어플리케이션으로 앱관련 이벤트 정보를 실시간으로 제공하기 위한 방법이라고 할 수 있다. 

Web Callback 또는 HTTP PUSH API로도 불린다.

 

※ 실시간이란?

- 해당 앱에서 특정 이벤트가 일어나는 즉시, 미리 지정해놓은 URL을 통해 다른 어플리케이션으로 이벤트 관련 정보를 보낸다는 의미이다.

 

3. Webhook URL 생성

- Add New Webhook to Workspace를 선택해서 메시지를 받을 채널 선택 

- 아래와 같이 URL이 추가됩니다.

5) Webhook URL을 복사하여 Github Repository 세팅에 Secrets로 등록

- 위치 : Setting - Security - Secrets ans variables - Actions - New repository secret

6) Github Actions workflows 파일 수정

https://github.com/marketplace/actions/action-slack

action-slack - GitHub Marketplace

- 이전에 작성했던 yml 파일에다가 Slack 메시지를 보내는 부분을 추가해보자.

steps:
  - uses: 8398a7/action-slack@v3
    with:
      status: ${{ job.status }}
      fields: repo,message,commit,author,action,eventName,ref,workflow,job,took,pullRequest # selectable (default: repo,message)
    env:
      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} # required
    if: always() # Pick up events even if the job fails or is canceled.

- 위의 가이드가 general 한 사용 사례이고, fields 에 선언되는 값들은 빌드 결과를 Slack 메시지로 보냈을 때 나오는 항목들이다. 

- status를 custom으로 하고, custom_payload: 을 사용해서 원하는대로 커스텀 할 수도 있다. 

 

아래 블로그를 참고하면 커스텀하는 방법에 대해 자세히 나와있따.

[Github Actions] GitHub Actions을 이용한 Slack 알림 설정하기

나는 우선 한번 모든 fields를 다 넣어서 테스트 해보았다.

그리고 추가적으로 failure 나 cancelled가 되었을때 mention하는 기능도 넣어봤다.

 

결과 ) 

- 로컬에서 코드 수정 후 Push

- Slack 메세지로 성공한 내역이 오는걸 확인할 수 있다 !