Github Changelog 자동화

🎯  Overview

Github Changelog 를 Github Workflow를 활용하여 자동화 해본다.

 

 

---

 

💻  Github Changelog 란?

📄 Changelog 란?

• 프로젝트에서 시간에 따라 이루어진 변경 사항을 기록하고 강조하는 문서이다.
• 오픈 소스 및 협업 프로젝트에서 기여자, 사용자, 이해관계자에게 새로운 기능, 버그 수정, 업데이트 또는 호환성 깨짐 등에 대해 알리기 위해 널리 사용된다.
• 새로운 기능, 버그 수정, 업데이트, 호환성 문제 등의 세부 정보가 포함된다.

📋 Changelog 구조

• 버전 관리 형식을 따르며 변경 사항을 체계적으로 정리한다.
• 최신 변경 사항부터 순서대로(역순) 릴리스 또는 태그별로 업데이트를 나열한다.
• 사용자가 프로젝트의 개발 기록을 효율적으로 검토할 수 있도록 한다.

​

 

🔍 Changelog 를 사용하는 이유는 무엇일까?

📢 Transparency(투명성)

• 각 릴리스에서 추가되거나 개선되거나 수정된 내용을 명확하게 전달한다.
• 개발자와 사용자가 변경 사항의 영향을 쉽게 이해할 수 있도록 돕는다.

🤝 Improved Collaboration(향상된 협업)

• 모든 기여자가 프로젝트의 진행 상황과 상태를 인지할 수 있도록 한다.
• 어떤 기능이나 수정 사항이 구현되었는지에 대한 오해를 최소화한다.

🔖 Version Tracking(버전 추적)

• 변경 사항을 특정 릴리스나 태그와 매핑한다.
• 여러 버전 간의 디버깅 및 테스트에 유용하다.

📬 User Communication(사용자 커뮤니케이션)

• 사용자가 업데이트를 추적하고 업그레이드 시점을 결정하는 데 유용한 정보를 제공한다.

 

 

 

🔧  Github Changelog 자동화

Github Workflow를 활용하여 Changelog를 자동화 해본다.

 

 

그리고 Workflow를 수동으로 실행해서 `Changelod.md` 를 생성한다.

 

 

다만, Github Action의 경우 특수하기 때문에 v1,2,3... 태그를 제외해줄 수 있다.

 

 

마무리

 

🔔 요약

• 변경 로그는 모든 프로젝트의 변경 사항을 추적하는 데 필수적인 도구이다.
• GitHub를 사용하면 워크플로를 사용하여 이 프로세스를 자동화하여 시간을 절약하고 팀과 사용자에게 일관된 업데이트를 제공할 수 있다
• 수동으로 관리하든 자동화를 활용하든, 변경 로그가 있으면 투명성이 구축되고 협업이 촉진되며 사용자에게 프로젝트 진행 상황에 대한 정보가 계속 제공된다.

 

 

 

 

---

📚 Reference

https://github.com/vweevers/common-changelog

https://keepachangelog.com/en/1.1.0/

https://semver.org/