introducing automatic changelog generator

[b6pzeusbc54tvhw5jgpyw8pwz2x6gs]

요구사항

1. CI 에서 자동으로 릴리스를 하는 https://github.com/semantic-release/semantic-release 는 제외. 릴리스는 사람의 손을 거쳐가게 하고 싶다.
2. https://www.conventionalcommits.org/ 을 준수하도록 commitlint 를 사용하고 있으므로 이 컨벤션을 파싱해야한다.
3. lerna version: independent 를 사용중이다. 각 package 별 changelog 를 리스팅 할 수 있어야 한다.

솔루션

• https://github.com/github-changelog-generator/github-changelog-generator

  • star 가 4902개. 그러나 github 에 종속되고 싶지 않다. 로컬 git log 만 참조하였으면 한다.

• https://github.com/tschaub/github-changelog

  • github 에 종속되기 싫고 star 25개로 도 적음. 빠르게 패스!

• https://github.com/matomo-org/github-changelog-generator

  • 위와 같은 이유로 빠르게 패스!

• https://github.com/git-chglog/git-chglog

  • 가장 유력한 솔루션. 그러나 요구사항 3번 때문에 코드 수정은 불가피할 듯.
  • config 는 yml 에, 템플릿은 go fmt template
  • tag prefix 를 지원안해준다
  • 빌드:

    $ docker run -it -v $PWD:/go/src/app -v $HOME/go:/go -v /Users/ssohjiro/project-poc/react-utterances:/root/react-utterances -w /go/src/app --rm golang:1.9
    $ dep 설치
    $ dep ensure
    $ make build
    $ make install
    $ git-chglog
    $ vi vendor/github.com/git-chglog/git-chglog/tag_reader.go

• https://github.com/lob/generate-changelog

  • type - scope 구조로
  • tag prefix 를 지원안해준다
  • 커스터마이징 할 수 있는 템플릿이 없다

• https://github.com/CookPete/auto-changelog

  • tag prefix 지원!
  • config 는 package.json 에, 템플릿은 handlebars
  • git-chglog 은 go lang 이었는데 이건 nodejs 라 필요한 부분을 수정하기 더 좋은데!

• https://github.com/semantic-release/release-notes-generator

  • 기능이나 옵션 지원은 많은 것 같음
  • @semantic-release 의 플러그인이라 cli 로 사용해 볼 순 없을 것 같음

[b6pzeusbc54tvhw5jgpyw8pwz2x6gs]

참고: https://github.com/github-changelog-generator/github-changelog-generator/wiki/Alternatives

[b6pzeusbc54tvhw5jgpyw8pwz2x6gs]

https://github.com/conventional-changelog/conventional-changelog 검토중...