릴리즈 노트 작성 반복 작업 자동화

오늘은 회사에서 사용하는 업무 툴을 좀 더 효율적으로 활용할 수 있는 방법에 대해 고민한 것을 공유하려고 해요.
 
저희 회사에서는 Jira로 이슈를 관리하고, Github으로 코드 형상 관리를, 그리고 Notion으로 릴리즈 노트를 작성하고 있어요.
보통 깃헙 배포 브랜치에 푸쉬한 내용을 가지고 노션에 릴리즈 노트를 작성하고, 관련된 지라 이슈도 언급해주곤 했어요.
 
격주로 하는 배포 때마다 이 작업을 반복해 왔는데, 문득 이걸 자동화할 수 없을까 하는 생각이 들더라고요. 
조금만 시간을 투자하면 반복적이고 지루한 작업을 자동화할 수 있을 것 같았거든요.
 

기존

우선 모듈마다 각각 다른 노션 데이터베이스를 사용하고 있었어요.
노션의 데이터베이스 기능을 활용하기 위해 일부러 나눈 것은 아니었던 것 같았어요.
그냥 엑셀 시트 하나 만드는 것처럼 매번 새로운 표를 만들어 썼던 거였죠.
 
그런데 이왕 데이터베이스 사용한다면 활용을 할 수 있는 쪽으로 바꾸고 싶었어요.
지금은 버전이 생길 때마다 1번처럼 템플릿으로 새 페이지를 만들고,
그 안에 2번처럼 모듈별로 새 표들이 생기는 구조거든요.

기존 릴리즈 노트 관리

 

문제 

이런 방식에는 몇 가지 문제점이 있다고 생각했어요.

1. 무엇보다 자동화할 수 있는데 수기로 작성하는 건 귀찮은 일이에요.
2. 매번 새 페이지를 만드는 수고로움도 있고요.
3. 항상 새로운 데이터베이스를 만들다 보니 데이터베이스 활용도가 많이 떨어져요.
4. 모듈별로 데이터베이스가 나뉘어 있어서 여러 모듈에 걸친 내용은 중복 등록해야 하고요.
5. 릴리즈 노트에 관련 지라 이슈를 찾아 링크 거는 것도 굉장히 번거로운 작업이에요.

 

자동화 개선

그래서 이런 식으로 개선해보면 어떨까 싶었어요.
 
먼저 깃헙 커밋 메시지에 지라 이슈 번호(JIRA-123 같은)와 모듈명(@account 같은)이 있으면 이를 인식해서 자동으로 노션에 릴리즈 노트를 작성하도록 하는 거예요.
 
참고로 저희는 MSA로 백엔드가 구성되어 있지만 같은 리포지토리에서 관리하고 있어요.
그래서 수정한 모듈을 커밋 제목에 명시하는 컨벤션이 있었죠.
이 컨벤션을 그대로 활용하면 릴리즈 노트 자동화에 딱 좋을 것 같더라고요.
 
예를 들면, 아래와 같은 커밋을 감지하면 릴리즈 노트가 자동으로 등록되는 것이죠.

git commit -m "JIRA-123 @account 통계 상세조회 성능 튜닝"

 
이를 위해 Github Action을 활용해서, 배포 브랜치에 커밋이 발생하면 이벤트를 감지하도록 설정하고,
미리 만들어둔 노션 데이터베이스에 API를 통해 데이터를 추가하는 방식으로 구현해봤어요.
 
커밋한 사람의 정보는 어떻게 가져올까 고민하다가, Github 이메일과 Notion 유저 ID를 매핑해둔 CSV 파일을 하나 만들기로 했어요.
이걸 활용하면 커밋 작성자를 릴리즈 노트의 담당자로 자동 지정할 수 있겠더라고요.
 

notion_user_id,github_email
aaa111,hello@google.com
bbb222,foo@naver.com
ccc333,john@github.com

 
버전 정보는 저희가 따로 버전 관리용 파일을 두고 있어서,
릴리즈 노트에 버전을 명시할 때 이 파일에 있는 정보를 가져오기로 했습니다.
 
최종적으로 모듈명이 여러 개면 멀티 셀렉트로, 지라 이슈 번호는 링크로 걸고, 커밋 제목과 내용은 각각 기능명과 요약 필드에 넣는 식으로 아래와 같이 간단하게 정리했어요.

코드로 직접 보고 싶으시다면, dusrnth/releasae-note-integration 에서 확인할 수 있어요.

 

마무리

이렇게 하면 어떤 장점이 있을까요?

1. 무엇보다 배포 브랜치에 커밋만 하면 자동으로 릴리즈 노트가 작성돼요.
2. 매번 새 페이지를 만들 필요가 없고요.
3. 모든 릴리즈 노트가 같은 데이터베이스에 쌓이니까 버전이나 지라 이슈로 필터링하는 등 데이터베이스 활용도가 훨씬 높아질 거예요.
4. 여러 모듈에 걸친 내용도 중복 작성 없이 한 번에 정리할 수 있겠죠.

이렇게 자동화를 설정하는 데에는 생각보다 시간이 많이 필요하지 않았어요.

하루 이틀정도의 시간만 할애 했음에도 팀 전체적인 반복 업무를 줄일 수 있게 되어 많이 뿌듯했답니다.

---