2020-11-07 16:52:09 +00:00
|
|
|
# Changeloguru
|
2020-11-10 17:25:56 +00:00
|
|
|
|
2021-12-02 07:17:54 +00:00
|
|
|
[](https://github.com/haunt98/changeloguru/actions)
|
2021-03-29 07:24:18 +00:00
|
|
|
[](https://pkg.go.dev/github.com/haunt98/changeloguru)
|
2021-08-20 18:07:16 +00:00
|
|
|
[](https://codecov.io/gh/haunt98/changeloguru)
|
2023-09-23 07:06:52 +00:00
|
|
|
[](https://github.com/haunt98/changeloguru/tags)
|
2020-11-10 17:25:56 +00:00
|
|
|
|
2023-09-23 07:06:52 +00:00
|
|
|
Tool to generate `CHANGELOG.md`, `CHANGELOG.rst` from
|
|
|
|
|
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
|
2020-11-10 17:25:56 +00:00
|
|
|
|
2020-11-11 03:34:14 +00:00
|
|
|
## Install
|
2020-11-10 17:25:56 +00:00
|
|
|
|
2021-03-15 17:00:47 +00:00
|
|
|
With Go version `>= 1.16`:
|
|
|
|
|
|
|
|
|
|
```sh
|
2021-05-11 05:35:58 +00:00
|
|
|
go install github.com/haunt98/changeloguru/cmd/changeloguru@latest
|
2021-03-15 17:00:47 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
With Go version `< 1.16`:
|
|
|
|
|
|
2020-11-10 17:25:56 +00:00
|
|
|
```sh
|
2021-05-11 05:35:58 +00:00
|
|
|
GO111module=on go get github.com/haunt98/changeloguru/cmd/changeloguru
|
2020-11-10 17:25:56 +00:00
|
|
|
```
|
2020-11-11 03:34:14 +00:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
2023-09-23 07:06:52 +00:00
|
|
|
`--from` is commit in the future aka new.
|
2022-02-07 13:45:04 +00:00
|
|
|
|
2023-09-23 07:06:52 +00:00
|
|
|
`--to` is commit in the past aka old.
|
|
|
|
|
|
|
|
|
|
Go from **future** to the **past**.
|
2022-02-07 13:45:04 +00:00
|
|
|
|
2020-11-11 03:34:14 +00:00
|
|
|
```sh
|
|
|
|
|
# Help
|
|
|
|
|
changeloguru --help
|
|
|
|
|
|
2020-11-11 16:05:39 +00:00
|
|
|
# Generate changelog v1.0.0
|
2021-04-11 09:11:41 +00:00
|
|
|
changeloguru generate --version v1.0.0
|
2020-11-11 16:05:39 +00:00
|
|
|
|
2021-01-05 09:00:48 +00:00
|
|
|
# Generate changelog v2.0.0 from HEAD to tag v1.0.0
|
2022-02-07 15:52:35 +00:00
|
|
|
changeloguru generate --version v2.0.0 --to v1.0.0
|
2021-04-14 10:10:17 +00:00
|
|
|
|
|
|
|
|
# Generate changelog in dry run mode (without changing anything)
|
2022-02-07 15:52:35 +00:00
|
|
|
changeloguru generate --version v2.0.0 --to v1.0.0 --dry-run
|
2021-04-14 10:10:17 +00:00
|
|
|
|
|
|
|
|
# Generate changelog only for scope
|
2022-02-07 15:52:35 +00:00
|
|
|
changeloguru generate --version v2.0.0 --to v1.0.0 --scope projectA --scope projectB
|
2022-10-10 03:11:18 +00:00
|
|
|
|
|
|
|
|
# Generate changelog in interactive mode (with instruction) and auto push commit, tag
|
|
|
|
|
changeloguru generate -i --auto-commit --auto-tag --auto-push
|
2020-11-11 03:34:14 +00:00
|
|
|
```
|
2020-12-18 09:58:31 +00:00
|
|
|
|
|
|
|
|
## Thanks
|
|
|
|
|
|
2021-01-05 08:59:46 +00:00
|
|
|
- [Command Line Interface Guidelines](https://clig.dev/)
|
2020-12-24 10:53:09 +00:00
|
|
|
- [fatih/color](https://github.com/fatih/color)
|
2020-12-18 09:58:31 +00:00
|
|
|
- [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)
|
2022-12-07 17:27:04 +00:00
|
|
|
|
2023-09-23 07:06:52 +00:00
|
|
|
Made with [GoLand](https://www.jetbrains.com/go/). Thanks for supporting open
|
|
|
|
|
source projects!
|
