배포 변경점을 정리하는 마크다운 릴리즈 노트 템플릿

무엇을 해결하나

commit 목록을 사용자 영향 중심의 신규 기능, 변경, 수정, 주의사항으로 재분류해 릴리즈 노트를 만들 때 사용합니다.

준비할 정보

• 실제 적용할 환경과 대상 범위를 먼저 적습니다.
• 현재 상태와 기대 결과를 숫자나 예시로 준비합니다.
• 운영 데이터, 개인정보, secret은 제거하거나 안전한 placeholder로 바꿉니다.
• 변경 작업이라면 승인자, backup, rollback 가능 여부를 확인합니다.

복사해서 쓰는 템플릿

아래 변경 목록으로 릴리즈 노트를 작성해줘.
버전/배포일: {{VERSION_DATE}}
변경 목록: {{CHANGES}}
호환성 영향: {{BREAKING_CHANGES}}
마이그레이션: {{MIGRATION}}

개발 용어를 사용자 표현으로 바꾸고 각 항목에 영향 범위와 필요한 행동을 표시해줘.

실행 순서

1. placeholder를 실제 환경 정보로 바꾸되 secret 값은 입력하지 않습니다.
2. 먼저 조회와 미리보기로 대상 범위, 권한, 현재 상태를 확인합니다.
3. 결과가 예상과 맞을 때만 가장 작은 단위로 실행하거나 초안을 생성합니다.
4. 변경 전후의 수치와 화면을 같은 조건에서 비교해 기록합니다.
5. 이상이 있으면 작업을 넓히지 말고 중단 조건과 rollback 절차를 따릅니다.

결과 확인

이슈와 PR 링크가 정확한지, 실제 배포 범위 밖의 기능이 섞이지 않았는지, breaking change와 되돌리기 방법이 눈에 띄는지 검수합니다.

검수 결과에는 확인한 사실, 아직 확인하지 못한 가정, 다음 행동을 분리해서 남깁니다. 다른 사람이 같은 입력으로 재현할 수 있도록 환경과 확인 시각도 함께 기록하면 좋습니다.

주의사항

자동 생성된 commit 요약은 내부 refactor를 과장할 수 있습니다. 사용자에게 보이는 변화가 없는 항목은 별도 기술 변경 섹션으로 분리합니다.

AI가 만든 설명과 명령은 초안입니다. 실제 제품 버전과 조직 정책, 공식 문서를 대조하고 영향이 있는 작업은 dev나 격리 환경에서 먼저 검증하세요.