2020-11-07 16:52:09 +00:00
|
|
|
# Changeloguru
|
2020-11-10 17:25:56 +00:00
|
|
|
|
2020-11-29 13:22:38 +00:00
|
|
|
|
|
|
|
|
[](https://pkg.go.dev/github.com/haunt98/changeloguru)
|
2020-11-10 17:25:56 +00:00
|
|
|
|
|
|
|
|
Tool to generate `CHANGELOG.md` from [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
|
|
|
|
|
|
2020-11-11 03:34:14 +00:00
|
|
|
## Install
|
2020-11-10 17:25:56 +00:00
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
GO111module=on go get github.com/haunt98/changeloguru
|
|
|
|
|
```
|
2020-11-11 03:34:14 +00:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
# Help
|
|
|
|
|
changeloguru --help
|
|
|
|
|
|
2020-11-11 16:05:39 +00:00
|
|
|
# Generate changelog v1.0.0
|
|
|
|
|
changeloguru --version v1.0.0
|
|
|
|
|
|
2020-11-11 03:34:14 +00:00
|
|
|
# Generate changelog v2.0.0 from HEAD to tag v1.0.0 (include commit in tag v1.0.0)
|
|
|
|
|
changeloguru --include-to v1.0.0 --version v2.0.0
|
|
|
|
|
|
|
|
|
|
# Generate changelog v2.0.0 from HEAD to tag v1.0.0 (exclude commit in tag v1.0.0)
|
|
|
|
|
changeloguru --exclude-to v1.0.0 --version v2.0.0
|
|
|
|
|
```
|
2020-12-18 09:58:31 +00:00
|
|
|
|
|
|
|
|
## Thanks
|
|
|
|
|
|
|
|
|
|
- [go-git/go-git](https://github.com/go-git/go-git)
|
|
|
|
|
- [google/go-cmp](https://github.com/google/go-cmp)
|
|
|
|
|
- [sebdah/goldie](https://github.com/sebdah/goldie)
|
|
|
|
|
- [stretchr/testify](https://github.com/stretchr/testify)
|
|
|
|
|
- [urfave/cli](https://github.com/urfave/cli)
|
