[Etc] Slack에서 Github 알림 받기

1. 개요

팀플 시작하면서 깃헙 작업 내용을 알림으로 받을 겸

Slack - Github 연결 작업을 진행하였다.

 

내가 Commit 내용으로 적은 내용을 Merge(또는 Pull Request) 시,

슬랙에서 자동으로 메시지가 작성되도록 하는 작업이다.

 

 

2. Slack - GitHub 연동

어떤 사이트에서 작업해야는지 헛갈릴 수 있으니 각 주제 옆에 괄호로 작업되는 위치를 달아두었으니 참고하자.

 

 

a. GitHub App 설치 (Slack)

먼저 Slack에 Git Repository를 연결하기 위한 GitHub App을 설치해줘야한다.

설치가 되어있지 않다면 Slack 좌측 Apps 탭에서 Add apps 버튼을 클릭하고 GitHub를 검색해서 설치하면 된다.

 

 

 

b. Invite GitHub (Slack)

설치가 완료되었으면 연결하고자 하는 Channel을 선택해준다.

(없다면 Add Channels 을 클릭하여 만들어주고 가자.)

 

선택한 채널 메시지 창에 GitHub App을 초대해준다.

/invite @github

 

 

초대가 완료되면 아래 이미지처럼 채널에 GitHub 가 추가되었다는 메시지를 볼 수 있다.

(채널에 다른 유저를 초대하는것과 같다.)

 

 

[Show Help] 버튼을 누르면 명령어에 대한 설명이 간략하게 나오니 궁금하다면 참고하자

 

 

c. Slack - GitHub 계정 연동 (Slack)

계정 연동은 아래 [Connect GitHub account] 버튼을 클릭하면 되는데,

해당 창이 안뜬다면 그 아래 이미지 처럼 메시지 입력 창에 작성해보자.

 

아래 명령어는 Repository 연결 명령어인데

계정 연결 이후에 [계정명 / Repo 이름] 으로 적어주면되기에 아래 이미지는 임시로 참고만 하자.

/github subscribe [your-repository]

 

 

[Connect GitHub account] 버튼을 누루면 팝업창이 뜨면서 연결 과정에 들어가게 되는데,

[Authorize Slack] 버튼을 누르면 Verification code 를 받게 된다.

(코드 복사 후 창을 닫으면 된다.)

 

 

해당 코드를 복사하고 채널 메시지 창으로 돌아와

[Enter Code] 버튼을 누르게 되면 아래 이미지처럼 코드 입력창이 팝업되게 된다.

입력 후 [Submit] 버튼을 누르면 Slack의 GitHub App에 계정 연동이 된다.

 

 

 

 

d. GitHub에 Slack GitHub App 설치 및 설정 (Slack -> GitHub)

계정 연동이 되었다면 GitHub 계정에서 Application 설치 및 설정 작업을 해야한다.

 

아래 이미지처럼 Slack 채널에 [Install GitHub App] 버튼이 나올텐데 클릭해준다.

(만약 안나온다면 위에서 입력했던 /github subscribe ~ 를 입력해주면 된다.)

 

 

 

버튼을 누른 뒤에는 연결을 허용할 Repository 를 선택하게 된다.

'for these repositories' 항목에서 전체를 허용할지 몇 가지 Repository만 골라서 허용할건지 선택을 하면 된다.

(여러 Repository 선택이 가능하니 [Select repositories] 버튼을 눌러 원하는만큼 추가하자.)

 

선택을 완료한 후에는 [Install] 버튼을 눌러준다.

눌러준 후에 설정한 부분을 확인시켜주는 창이 뜨고 나중에 다시 확인하고 싶다면 GitHub 에서 [Setting - Application - Slack] 에서 확인 및 수정이 가능하다.

 

 

 

e. Repository Subscribe (Slack)

드디어 위에서 계속 언급했던 Repository 등록 부분이다.

바로 위에서 작업한 Repository 허용 부분에 등록한 Repository를 입력해주면 된다.

(만약 허용되지않은 Repository를 입력하면 Install 하라고 메시지가 뜨기 때문에 허용하였는지 확인하자!)

 

/github subscribe [account_name/repo_name]

 

등록 후, Repository 에서 작업된 내용이 메시지 형태로 보이는 부분을 볼수 있다.

바로 사용할때는 브랜치에서 작업된 내용은 Merge 하는 시점에야 볼수 있었어서 추가적인 알람을 받고 싶다면 공식문서를 참고하여 작업하면 될듯하다.

 

 

3. 참고 문서

https://github.com/integrations/slack#readme

GitHub - integrations/slack: Bring your code to the conversations you care about with the GitHub and Slack integration

https://ebabby.tistory.com/27

슬랙(Slack)에 깃허브(Github) 알림 연동하기