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
This build depends on git2 with the zlib-ng-compat feature. It requires cmake.
```shell script
docker build -t convco .
docker run -v "$PWD:/tmp" --workdir /tmp --rm convco ```
If you've created an image and pushed it into your private registry
yaml
convco:check:
stage: test
image:
name: convco/convco:latest
script:
- check
A changelog can be generated using the conventional commits. It is inspired by conventional changelog. Configuration follows the conventional-changelog-config-spec
sh
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.
sh
convco check $remote_sha..$local_sha
Helps to make conventional commits. A scope, description, body, breaking change and issues will be prompted.
```sh
convco commit --feat -- --patch ```
When no options are given it will return the current version.
When --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 --major, --minor or --patch to overrule the convention.
sh
convco version --bump
It is useful to use it with release tools, such as cargo-release:
sh
cargo release $(convco version --bump)
.versionrc file