yoshie
/
changeloguru
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
changeloguru/README.md

50 lines
1.4 KiB
Markdown
Raw Normal View History

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(readme): add thanks Command Line Interface Guidelines
2021-01-05 08:59:46 +00:00
[![Go](https://github.com/haunt98/changeloguru/workflows/Go/badge.svg?branch=main)](https://github.com/actions/setup-go)
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)
docs: add github action badge and install guide in README
2020-11-10 17:25:56 +00:00
Tool to generate `CHANGELOG.md` from [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
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
go install github.com/haunt98/changeloguru@latest
```
With Go version `< 1.16`:
docs: add github action badge and install guide in README
2020-11-10 17:25:56 +00:00
```sh
GO111module=on go get github.com/haunt98/changeloguru
```
docs: add usage guide in README
2020-11-11 03:34:14 +00:00
## Usage
```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
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 --to v1.0.0 --version v2.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)
changeloguru generate --to v1.0.0 --version v2.0.0 --dry-run
# Generate changelog only for scope
changeloguru generate --to v1.0.0 --version v2.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)