Jira Slack API를 이용하여 Daily Report 자동화

01 Jul 2024

회사에서 매일 업무 시작과 종료 시에 Slack을 이용해 데일리 리포트를 작성한다.

💡 0000.00.00 (월) 금일 업무 수행할 계획 [근무지: xxx오피스] [Jira 티켓] [BE] 테스트 코드 작성 estimated 1h / left 1h

💡 0000.00.00 (월) 금일 업무 수행한 내용 [근무지: xxx오피스] [Jira 티켓] [BE] 테스트 코드 작성 estimated 1h / left 1h / progress 1h –> left 0h [done]

업무의 시작과 종료에 어떤 업무를 해야 하고 얼마나 진행했는지 파악하기는 좋지만, 불편한 점이 몇 가지가 있었다.

날짜, 요일, Jira 티켓 넘버 등 오타 발생
- 아무래도 수기로 작성하다 보니 잘못된 날짜나 요일로 작성하거나 Jira 티켓 넘버가 맞지 않는 오류가 있어서 나중에 발견하고 수정하는 경우가 종종 있었다.
데일리 리포트 작성 자체를 잊어버리는 경우가 발생
- 보통의 경우라면 까먹지 않지만, 아침에 출근하자마자 이슈가 생겨서 회의를 하거나, 버그 발생으로 정신 없는 상태라면 잊어버리는 경우가 생겼다.
Jira에 있는 정보를 작성할 필요가 있을까?
- 데일리 리포트는 말하자만 직접 작성하는 Jira 티켓이다. Jira에 똑같은 내용을 확인할 수 있는데 굳이 Slack 채널에 메시지를 작성해야 하는지와 같은 필요성에 의문이 들었다.

이러한 문제점들이 있어서 데일리 리포트를 자동화해주는 서버를 만들어 효율을 높이려 시도했다.

먼저 구현 흐름은 이렇게 잡았다.

Jira API를 이용해서 원하는 이슈 정보 불러온다.
- 데일리 리포트에 [진행 중]인 이슈와 오늘 완료한 [완료됨]의 이슈의 정보가 필요함
불러온 이슈를 서버에서 가공
- 회사에서 사용하는 데일리 리포트 양식이 있었기 때문에 해당 양식으로 출력해야 하기 때문에 가공하는 작업이 필요하다.
- 이슈의 추정 시간, 소요 시간 등은 가져올 수 있지만 진행한 시간은 계산을 해야 했기 때문에 해당 로직도 필요하다.
평일 (월 ~ 금) 업무 시작 시간인 오전 09시와 업무 종료 시간인 오후 06시에 @Scheduler를 사용하여 자동으로 Slack으로 메시지를 보낸다.

Jira API 연동을 위해 openfeign 의존성을 추가해주고 scheduler batch job을 위해 spring batch를 추가해준다.

Slack Message를 이용하기 위해 Slack 의존성도 추가해준다.

먼저 @EnableScheduling, @EnableFeignClients 를 추가해서 scheduler와 feign client를 활성화 해준다.

Feign client를 이용하여 Jira api에 issue 정보를 요청한다.

여기서 jql은 Jira Query Language이다. Jira Issue 를 검색하기 위한 구조적인 언어이다.

Jira API에서 받아온 정보를 가공하여 Slack으로 전송한다.

Slack에서는 메시지를 Block Template를 이용하여 작성할 수 있다.

Slack API를 이용하여 Blocks를 이용하여 원하는 템플릿을 만들고 chatPostMessage를 이용하여 메시지를 보낸다.

성공적으로 메시지가 나오는 모습을 보인다.

alt text