title: "release note 생성, versioning 자동화를 위한 규격 : Conventional Commits, Keep a Changelog, Semantic Versioning"
description: "효과/효율적으로 release note 및 version 관리를 하기 위한 주요 규격 - Conventional Commits, Semantic Versioning, CHANGELOG.md에 관한 논의이다."
cleanUrl: /sw-engineer/standard-for-releasenote-versioning-releasenote
floatFirstTOC: right

Introduction

효과/효율적으로 release note 및 version 관리를 하기 위한 주요 규격 - Conventional Commits, Semantic Versioning, CHANGELOG.md에 관한 논의이다.

Motivation

• release note는 내용 상 git log와 겹침. git log와 별개로 release note 작성은 상당히 거추장스러움과 동시에 비효율적인 일.
• 따라서 git log를 잘만 활용하면 release note 생성은 자동화 가능
• 그리 비범하지 않은 아이디어인데 이미 open source로 마련되어 있을 듯.

Summary

• Conventional Commits을 따라 commit log를 작성하면 release note 생성 및 versioning을 자동화할 수 있는 기반이 마련됨.
• Conventional Commits은 매우 쉽고 단순함.
• Conventional Commits은 Semantic Versioning(SemVer)과 일반적 CHANGLOG.md 형식과 잘 어울림.
• Semantic Versioning(SemVer)은 Open Source communities에서 versioning의 de facto 표준으로 통용됨.
• release note는 CHANGELOG.md란 이름의 파일로 큰 규모의 Open Source communities에서 주로 사용 중. 포맷 표준은 없으나 일반적으로 사용되는 포맷이 있음.

Conventional Commits

• site link : https://www.conventionalcommits.org/en/v1.0.0/

• github link : https://github.com/conventional-commits/conventionalcommits.org (Star 5.4k, Fork 469. 23.07.02 현재)

• site 모토 : 사람과 기계 모두가 읽을 수 있는 commit message를 위한 규격

  원문 : A specification for adding human and machine readable meaning to commit messages

Conventional Commits을 사용하면 무엇이 좋은지

<aside> 💡 https://www.conventionalcommits.org/ko/v1.0.0/#왜-conventional-commits를-사용할까요 에서 추출

</aside>