CoCo

Conventional commit tool (read about them here).

Usage

Validate

# validate a git reference (a commitish)
coco validate --ref HEAD

# validate a msg provided on stdin
git show -s --format=%B HEAD | coco validate

# validate a msg from file ... useful for e.g. .git/hooks/pre-commit
coco validate --file "$1"

Next Version

coco determines the semantic version of the next release by looking at the existing reachable tags and the since made commits. To do this, there must be at least one tag already, as there is no way to guess the maturity of the project. Given that your project is still in the 'initial development' phase (major version 0) breaking changes won't increment the major version yet. You must therefore manually tag it as 1.0.0 when you are ready.

# creating a new tag
git tag "v$(coco next-version)"

example

# current tags (tags CAN be prefixed with 'v')
$ git tag
v1.0.0
v1.0.1
v1.0.2

# since made commits
$ git log --oneline v1.0.1..HEAD
<sha> feat(X): some feature around X
<sha> fix(Y): damn Y was broken

$ coco next-version
1.1.0

Dev Tags

The above example assume that tags were made on main and HEAD is also pointing at it. But the tags that are used for evaulation MUST be reachable from HEAD. Example:

    v1.0.0                v2.0.0
----(feat)---(breaking)---(feat)---    main 
     \
      \                ?
       \---(feat)---(feat)             some-branch|HEAD

'?' will be evaluated to 1.1.0 since 2.0.0 is not reachable from HEAD. To perform a dev tag on that branch one can therefore simply do:

# create a tag of format: <Major>.<Minor>.<Patch>-dev+<Short-Sha>
git tag "$(coco next-version)-dev+$(git rev-parse --short HEAD)"

All non release tags won't play a role in the calculation of the next-version.

Development

git clone <repo> <dest>
cd <dest>
# we don't need to get everything as we only need this for the header files
# or when you want to build libgit2 yourself
git submodule --update --init --recursive --filter=tree:0

Building

# build coco with libgit2 pre-built as static library
zig build -Dlibgit2-object=/path/to/libgit2.a -Dlibgit2-version v1.7.2

# build coco using the script 'build-libgit2' to build
# libgit2 (the build will be cached but requires docker to be installed)
zig build

Releases

# built using
zig build -Dtarget=x86_64-linux-musl -Doptimize=ReleaseSmall

TODO

narrow the error's atm. every is '!...'
use @embedFile to get the usage?

Sojamann/coco