convention_change_log

README

for what

• convention change log generate
• convention change log reader

Features

• more perfect test case coverage
• more perfect benchmark case

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.0.0
$ go install -v github.com/convention-change/convention-change-log/cmd/convention-change-log@v1.0.0

• 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