yoshie
/
changeloguru
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
changeloguru/README.md

1.9 KiB
Raw Blame History

Changeloguru

Go Go Reference codecov Quality Gate Status

Tool to generate CHANGELOG.md, CHANGELOG.rst from Conventional Commits.

Roadmap

  • Support CHANGELOG.txt
  • Interactive mode
  • Unit test

Install

With Go version >= 1.16:

go install github.com/haunt98/changeloguru/cmd/changeloguru@latest

With Go version < 1.16:

GO111module=on go get github.com/haunt98/changeloguru/cmd/changeloguru

Usage

--from is commit in the future.

-to is commit in the past.

# Help
changeloguru --help

# Generate changelog v1.0.0
changeloguru generate --version v1.0.0

# Generate changelog v2.0.0 from HEAD to tag v1.0.0
changeloguru generate --version v2.0.0 --to v1.0.0

# Generate changelog in dry run mode (without changing anything)
changeloguru generate --version v2.0.0 --to v1.0.0 --dry-run

# Generate changelog only for scope
changeloguru generate --version v2.0.0 --to v1.0.0 --scope projectA --scope projectB

Thanks