변경 로그 구현

완료됨

변경 로그의 개념은 매우 간단합니다. 프로젝트에 대한 변경 내용 목록(일반적으로 날짜 순서)을 포함하는 파일을 나타냅니다. 일반적으로는 버전 목록을 분리하고 각 버전 내에서 다음을 표시합니다.

  • 추가된 기능
  • 수정/향상된 기능
  • 삭제된 기능

변경 로그를 블로그 게시물로 게시하는 팀도 있고 GitHub 리포지토리에서 CHANGELOG.md 파일을 만드는 팀도 있습니다.

자동화된 변경 로그 도구

변경 로그를 만들고 수동으로 유지 관리할 수 있지만 자동화된 변경 로그 생성 도구를 사용할 수도 있습니다. 적어도 시작점으로 사용할 수 있습니다.

네이티브 GitHub 명령 사용

git log 명령은 자동으로 콘텐츠를 만드는 데 유용할 수 있습니다. 예: create a new section per version:

git log [options] vX.X.X..vX.X.Y | helper-script > projectchangelogs/X.X.Y

Git 변경 로그

하나의 표준 도구는 gitchangelog입니다. 이 도구는 Python을 기준으로 합니다.

GitHub 변경 로그 생성기

또 다른 표준 도구를 github-changelog-generator라고 합니다.

$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0

이 도구는 Gem을 기준으로 합니다.

자동 생성되는 로그 기반 데이터를 사용해야 하나요?

기본 설정은 항상 로그 항목을 변경 로그 항목으로 덤프하지 않는 것입니다. 로그는 “불안정”하므로 유용하지 않은 상황이 발생하기 쉽습니다.