changeloguru/README.md

# Changeloguru

[![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)
[![codecov](https://codecov.io/gh/haunt98/changeloguru/branch/main/graph/badge.svg?token=ZBG353F0CN)](https://codecov.io/gh/haunt98/changeloguru)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=haunt98_changeloguru&metric=alert_status)](https://sonarcloud.io/dashboard?id=haunt98_changeloguru)

Tool to generate `CHANGELOG.md`, `CHANGELOG.rst` from [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).

## Roadmap

- [ ] Support `CHANGELOG.txt`
- [ ] Interactive mode
- [ ] Unit test

## 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
```

## Usage

`--from` is commit in the future.

`-to` is commit in the past.

```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
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

- [Command Line Interface Guidelines](https://clig.dev/)
- [fatih/color](https://github.com/fatih/color)
- [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)
feat: get commits in path between from and to revision 2020-11-07 16:52:09 +00:00			`# Changeloguru`
docs: add github action badge and install guide in README 2020-11-10 17:25:56 +00:00
chore: update README badge 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)`
chore(readme): remove lgtm alerts badge 2021-03-29 07:24:18 +00:00			`[![Go Reference](https://pkg.go.dev/badge/github.com/haunt98/changeloguru.svg)](https://pkg.go.dev/github.com/haunt98/changeloguru)`
chore(readme): add codecov badge 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)`
chore(readme): add sonar badge 2021-08-20 19:02:20 +00:00			`[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=haunt98_changeloguru&metric=alert_status)](https://sonarcloud.io/dashboard?id=haunt98_changeloguru)`
docs: add github action badge and install guide in README 2020-11-10 17:25:56 +00:00
chore(readme): add rst filetype 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/).
docs: add github action badge and install guide in README 2020-11-10 17:25:56 +00:00
chore: update roadmap 2022-02-03 16:46:57 +00:00			`## Roadmap`

			- [ ] Support `CHANGELOG.txt`
			`- [ ] Interactive mode`
			`- [ ] Unit test`

docs: add usage guide in README 2020-11-11 03:34:14 +00:00			`## Install`
docs: add github action badge and install guide in README 2020-11-10 17:25:56 +00:00
chore(readme): add guide for install with go 1.16 2021-03-15 17:00:47 +00:00			With Go version `>= 1.16`:

			```sh
chore(readme): correct link how to install 2021-05-11 05:35:58 +00:00			`go install github.com/haunt98/changeloguru/cmd/changeloguru@latest`
chore(readme): add guide for install with go 1.16 2021-03-15 17:00:47 +00:00			```

			With Go version `< 1.16`:

docs: add github action badge and install guide in README 2020-11-10 17:25:56 +00:00			```sh
chore(readme): correct link how to install 2021-05-11 05:35:58 +00:00			`GO111module=on go get github.com/haunt98/changeloguru/cmd/changeloguru`
docs: add github action badge and install guide in README 2020-11-10 17:25:56 +00:00			```
docs: add usage guide in README 2020-11-11 03:34:14 +00:00
			`## Usage`

chore: explain --from, --to 2022-02-07 13:45:04 +00:00			`--from` is commit in the future.

			`-to` is commit in the past.

docs: add usage guide in README 2020-11-11 03:34:14 +00:00			```sh
			`# Help`
			`changeloguru --help`

docs: add usage guide for generate changelog first time 2020-11-11 16:05:39 +00:00			`# Generate changelog v1.0.0`
refactor: use better commands and flags name (#7) * build: update go.mod * refactor: replace debug with verbose * refactor: split action from main * refactor: move all cli app inside pkg cli * chore(readme): use generate command Co-authored-by: Tran Hau <ngtranhau@gmail.com> 2021-04-11 09:11:41 +00:00			`changeloguru generate --version v1.0.0`
docs: add usage guide for generate changelog first time 2020-11-11 16:05:39 +00:00
chore(readme): remove --include-to, --exclude-to in guide 2021-01-05 09:00:48 +00:00			`# Generate changelog v2.0.0 from HEAD to tag v1.0.0`
chore: put version before from, to 2022-02-07 15:52:35 +00:00			`changeloguru generate --version v2.0.0 --to v1.0.0`
chore(reamde): add --dry-run and --scope flag in guide 2021-04-14 10:10:17 +00:00
			`# Generate changelog in dry run mode (without changing anything)`
chore: put version before from, to 2022-02-07 15:52:35 +00:00			`changeloguru generate --version v2.0.0 --to v1.0.0 --dry-run`
chore(reamde): add --dry-run and --scope flag in guide 2021-04-14 10:10:17 +00:00
			`# Generate changelog only for scope`
chore: put version before from, to 2022-02-07 15:52:35 +00:00			`changeloguru generate --version v2.0.0 --to v1.0.0 --scope projectA --scope projectB`
docs: add usage guide in README 2020-11-11 03:34:14 +00:00			```
chore: add Thanks in README 2020-12-18 09:58:31 +00:00
			`## Thanks`

chore(readme): add thanks Command Line Interface Guidelines 2021-01-05 08:59:46 +00:00			`- [Command Line Interface Guidelines](https://clig.dev/)`
chore(readme): add fatih/color in thanks 2020-12-24 10:53:09 +00:00			`- [fatih/color](https://github.com/fatih/color)`
chore: add Thanks in README 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)`