CHANGELOG 작성 자동화

[giwan-dev]

문제점

CHANGELOG를 각 PR에서 작성하는 방법이 불편합니다. 모든 Pull Request에서 CHANGELOG.md 파일이 바뀌기 때문에 하나의 PR이 머지되면 다른 PR은 무조건 충돌이 생깁니다.

또한, 매 릴리즈마다 CHANGELOG에 빼먹은 것은 없는지 확인해야합니다. milestone으로 릴리즈에 포함되는 PR을 관리하고 있음에도 한 번 더 담당자의 눈으로 확인해야합니다.

해결 방법

마일스톤을 닫으면 CHANGELOG를 작성하고 Pull Request를 올리는 workflow를 생각했습니다. 릴리즈 담당자가 마일스톤을 닫으면 workflow가 작동합니다. workflow에서 CHANGELOG를 수정하는 액션이나 릴리즈 노트를 생성하는 액션으로 이번 릴리즈에 포함되는 변경 사항을 CHANGELOG.md에 반영합니다. 이후 브랜치를 생성하고, 수정 내역을 커밋하고, 푸시한 다음 PR을 열어줍니다. 릴리즈 담당자는 PR을 검토하고 버전을 올리는 커밋을 추가한 다음 리뷰를 받고 머지합니다.

추가로 할 일

• Pull Request 템플릿에서 CHANGELOG 관련 체크리스트를 없앱니다.

Thanks to 스티브