A Conventional commit cli.
convco gives tools to work with Conventional Commits.
The tool is still in early development. It provides already the following commands:
convco changelog: Create a changelog file.
convco check: Checks if a range of commits is following the convention.
convco commit: Helps to make conventional commits.
convco version: Finds out the current or next version.
cargo install convco
# build the convco image docker build -t convco . # run it on any codebase docker run -v "$PWD:/tmp" --workdir /tmp --rm convco
Use it in .gitlab-ci.yml
If you've created an image and pushed it into your private registry
convco:check: stage: test image: name: $PATH_OF_PRIVATE_REGISTRY/convco-alpine:latest entrypoint: [""] script: - convco check
convco changelog > CHANGELOG.md
Check a range of revisions for compliance.
It returns a non zero exit code if some commits are not conventional. This is useful in a pre-push hook.
convco check $remote_sha..$local_sha
Helps to make conventional commits. A scope, description, body, breaking change and issues will be prompted.
# commit a new feature and then run git commit with the interactive patch switch convco commit --feat -- --patch
When no options are given it will return the current version.
--bump is provided, the next version will be printed out.
Conventional commits are used to calculate the next major, minor or patch.
If needed one can provide
--patch to overrule the convention.
convco version --bump
It is useful to use it with release tools, such as
cargo release $(convco version --bump)
- automatic notes for breaking changes
- custom template folder
- use a
- limit to a range of versions
- sort sections in changelog
- issue references
- better documentation
- better error handling