convention_change_log

README

for what

• convention change log generate
• convention change log reader
• convention change log config by .versionrc file

Features

• subcommand init to init config file
• can read git root .versionrc for setting of change log generate
  • support change log item sort by versionrc config {{ .types[ .sort ] }}, and default sort will auto set by this kit
  • more settings see init --more out file
• subcommand read-latest read the latest change log or write latest change to file
• global flag
  • -r or --release-as to set release version
  • --dry-run flag can see what change of new release
  • --auto-push flag can auto push tag to remote
  • --tag-prefix flag can change tag prefix
• generate from conventional commits for semver.org
  • default will update PATCH version
  • if the latest list has any feat message will update MINOR version
  • if want change release version please use global flag -r
• auto update version resource
  • project has package.json file, will auto update version field
  • project has package-lock.json file, will try use npm install to update package-lock.json file
• more perfect test case coverage

more use see convention-change-log --help

usage

cli

# install at $(GO_PATH)/bin
$ go install -v github.com/convention-change/convention-change-log/cmd/convention-change-log@latest
# install version v1.4.0
$ go install -v github.com/convention-change/convention-change-log/cmd/convention-change-log@v1.4.0

• or install by release and add environment variables PATH

• please use cli at git repository root path

# init config file at git repository root path
$ convention-change-log init

# check release note by tag
$ convention-change-log --dry-run
# let release version as -r
$ convention-change-log -r 0.1.0 --dry-run
# change tag prefix
$ convention-change-log -r 0.1.0 -t "" --dry-run

# finish check then generate release note and tag
$ convention-change-log -r 1.0.0

# or add auto push to remote
$ convention-change-log --auto-push

dev

env

• minimum go version: go 1.18
• change go 1.18, ^1.18, 1.18.10 to new go version

libs

lib	version
https://github.com/stretchr/testify	v1.8.4
https://github.com/sebdah/goldie	v2.5.3

• more libs see go.mod

Contributing

We welcome community contributions to this project.

Please read Contributor Guide for more information on how to get started.

请阅读有关 贡献者指南 以获取更多如何入门的信息

local dev

# It needs to be executed after the first use or update of dependencies.
$ make init dep

• test code

$ make test testBenchmark

add main.go file and run

# run at env dev use cmd/main.go
$ make dev

• ci to fast check

# check style at local
$ make style

# run ci at local
$ make ci

docker

# then test build as test/Dockerfile
$ make dockerTestRestartLatest
# clean test build
$ make dockerTestPruneLatest

# more info see
$ make helpDocker

Documentation

Index

• Variables

Variables

var PackageJson string

var ResVersionRcBeautyJson string