Why
Github에 변경사항이 생기면, 그 내용이 메일로 발송되어 확인할 수 있습니다.
하지만, 이메일로 받다보면 가끔 다른 메일에 밀려 잘 확인하지 않게되는 상황이 때때로 생겼습니다.
특히 이슈나 pull request을 했을 경우 빠른 응답을 받기를 원하지만, 1시간내 팀원들의 응답률이 약 50%정도 됐습니다. (4명 기준 약 2명정도가 확인)
그래서 확인을 바라는 상황이 올 때마다 팀원들은 채팅방에 github 변경 사실을 직접 공유했는데, 이랬을경우 30분 내에 확인할 확률이 90%정도 되어서, 이메일로 하는 것보다 단체 채팅방에 공유하는 것이 더 효과적이라는 것을 확인했습니다.
How
이 프로세스을 좀 더 줄이고자 찾아본 것이 Github의 Webhooks입니다.
- Github Webhooks는 Github 저장소에서 발생하는 이벤트를 감지하고, 이벤트에 대한 알림과 데이터를 다른 서비스나 애플리케이션으로 전달하는 기능을 제공합니다.
- GitHub에서 특정 이벤트가 발생했을 때 이벤트 정보를 HTTP POST 요청으로 보내줍니다.
Discord 웹후크 만들기
- 디스코드의 채팅방 설정에 들어갑니다. (톱니바퀴 모양)
- 왼쪽 사이드바에서 연동을 클릭합니다.
- 웹후크 만들기를 클릭합니다.
- Bot 정보에 대해 설정하는 곳에서 웹후크 URL 복사를 클릭합니다.
리포지토리 웹후크 만들기
- 리포지토리의 기본 페이지로 이동합니다.
- 리포지토리 이름 아래에서 Settings(설정)를 클릭합니다. "설정" 탭이 표시되지 않으면 드롭다운 메뉴를 선택한 다음 설정을 클릭합니다.
- 왼쪽 사이드바에서 Webhooks(웹후크)를 클릭합니다.
- Add webhooks(웹후크 추가)를 클릭합니다.
- Discord Webhook URL 을 붙여넣고 맨 끝에
/github
을 추가합니다.
- 필요에 따라 콘텐츠 형식 드롭다운 메뉴를 선택하고 웹후크 페이로드를 수신할 데이터 서식을 클릭합니다. 대부분
application/json
를 사용합니다.
- "이 웹후크를 트리거할 이벤트는 무엇인가요?"에서 수신하려는 웹후크 이벤트를 선택합니다. (택 1)
- push 알림만 받기
- 모든 알림받기
- Discord로 알림받고 싶은 이벤트 종류를 체크
- Add webhook(웹후크 추가)를 클릭합니다.
이제 Discord 알림으로 해당 Repository 활동을 받아볼 수 있습니다.
참고 : https://docs.github.com/ko/webhooks/using-webhooks/creating-webhooks