9 releases

0.3.2 Oct 29, 2020
0.3.1 Aug 30, 2020
0.2.3 May 17, 2020
0.2.2 Feb 16, 2020
0.1.1 Dec 29, 2019

#36 in Build Utils

Download history 12/week @ 2020-08-03 35/week @ 2020-08-10 46/week @ 2020-08-17 34/week @ 2020-08-24 26/week @ 2020-08-31 40/week @ 2020-09-07 14/week @ 2020-09-14 4/week @ 2020-09-21 22/week @ 2020-09-28 4/week @ 2020-10-05 1/week @ 2020-10-12 26/week @ 2020-10-19 18/week @ 2020-10-26 10/week @ 2020-11-02 7/week @ 2020-11-09 3/week @ 2020-11-16

89 downloads per month

MIT license

78KB
2K SLoC

Convco

GitHub Workflow Status Crates.io

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.

Installation

cargo install convco

Docker usage

# 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

Tools

Changelog

A changelog can be generated using the conventional commits. It is inspired by conventional changelog. Configuration follows the conventional-changelog-config-spec

convco changelog > CHANGELOG.md

Check

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

Commit

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

Version

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.

convco version --bump

It is useful to use it with release tools, such as cargo-release:

cargo release $(convco version --bump)

TODO

  • automatic notes for breaking changes
  • custom template folder
  • use a .versionrc file
  • limit to a range of versions
  • sort sections in changelog
  • issue references
  • better documentation
  • better error handling

Dependencies

~18MB
~413K SLoC