changeloguru/README.md

58 lines
1.8 KiB
Markdown
Raw Normal View History

# Changeloguru
2021-12-02 07:17:54 +00:00
[![Go](https://github.com/haunt98/changeloguru/workflows/Go/badge.svg?branch=main)](https://github.com/haunt98/changeloguru/actions)
[![Go Reference](https://pkg.go.dev/badge/github.com/haunt98/changeloguru.svg)](https://pkg.go.dev/github.com/haunt98/changeloguru)
2021-08-20 18:07:16 +00:00
[![codecov](https://codecov.io/gh/haunt98/changeloguru/branch/main/graph/badge.svg?token=ZBG353F0CN)](https://codecov.io/gh/haunt98/changeloguru)
2021-06-16 18:00:00 +00:00
Tool to generate `CHANGELOG.md`, `CHANGELOG.rst` from [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
2020-11-11 03:34:14 +00:00
## Install
With Go version `>= 1.16`:
```sh
go install github.com/haunt98/changeloguru/cmd/changeloguru@latest
```
With Go version `< 1.16`:
```sh
GO111module=on go get github.com/haunt98/changeloguru/cmd/changeloguru
```
2020-11-11 03:34:14 +00:00
## Usage
2022-02-07 13:45:04 +00:00
`--from` is commit in the future.
`-to` is commit in the past.
2020-11-11 03:34:14 +00:00
```sh
# 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
2022-02-07 15:52:35 +00:00
changeloguru generate --version v2.0.0 --to v1.0.0
# 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
# 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
- [Command Line Interface Guidelines](https://clig.dev/)
- [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)