기록에서 문서로 변환
개발 과정의 커밋 기록은 사용자에게 보여줄 변경 기록과 목적이 다를 수 있다. Git-cliff는 Git 이력을 입력으로 받아 변경 기록 파일을 생성한다. 어떤 메시지를 어떻게 해석할지 정하는 규칙과 결과를 어떤 문서 형태로 보여줄지 정하는 템플릿이 함께 작동한다.
메시지 규칙에 맞춘 해석
Conventional Commits를 활용할 수 있고 정규식 기반 사용자 정의 파서도 지원한다. 따라서 모든 저장소가 동일한 메시지 관례를 사용해야만 하는 것은 아니다. 다만 입력 기록의 내용과 파싱 규칙에 따라 생성 결과가 달라지므로 문서가 전달해야 할 정보가 기록에 있는지 확인해야 한다.
템플릿과 설정의 역할
변경 기록 템플릿을 설정 파일에서 조정해 필요한 형식으로 출력할 수 있다. 설정은 TOML과 YAML을 지원하며 지정한 파일이 없으면 프로젝트와 사용자 설정을 탐색하고 기본값을 적용한다. 문서 생성을 도와주는 도구이지 실제 변경의 정확성이나 릴리스 품질까지 판정하는 도구는 아니다.
관련 문서
Changie / Commitlint / Commitizen / Danger JS / EditorConfig