changeloguru/README.md

Changeloguru

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

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

# Generate changelog in interactive mode (with instruction) and auto push commit, tag
changeloguru generate -i --auto-commit --auto-tag --auto-push

Thanks

• Command Line Interface Guidelines
• fatih/color
• go-git/go-git
• google/go-cmp
• sebdah/goldie
• stretchr/testify
• urfave/cli

Made with GoLand. Thanks for supporting open source projects!