A utility (and eventual create) for working with conventional commits in Git repository.
Find a file
2025-08-13 19:38:11 -05:00
.config fix: corrected paths on the schema 2025-08-13 15:48:05 -05:00
.vscode build: trying to get NixOS and Code to play well together 2025-08-10 20:41:49 -05:00
docs fix: corrected paths on the schema 2025-08-13 15:48:05 -05:00
news fix: corrected paths on the schema 2025-08-13 15:48:05 -05:00
src fix: corrected paths on the schema 2025-08-13 15:48:05 -05:00
.editorconfig chore: initial commit of ideas 2024-03-09 01:00:57 -06:00
.envrc chore: updating project to latest flake 2025-08-10 19:34:04 -05:00
.gitignore chore: initial commit of ideas 2024-03-09 01:00:57 -06:00
.prettierignore chore: initial commit of ideas 2024-03-09 01:00:57 -06:00
Cargo.lock build: normalizing the rust version on nixos 2025-08-13 19:31:12 -05:00
Cargo.toml chore: bumping version to v0.2.0 2025-08-13 18:28:54 -05:00
CODE_OF_CONDUCT.md chore: initial commit of ideas 2024-03-09 01:00:57 -06:00
DCO.md chore: initial commit of ideas 2024-03-09 01:00:57 -06:00
flake.lock build(nixos): updated the project flake 2025-08-13 19:38:11 -05:00
flake.nix build: normalizing the rust version on nixos 2025-08-13 19:31:12 -05:00
Justfile feat: introduced package name substitution in paths and tag prefixes 2025-08-11 11:11:07 -05:00
README.md feat: refactored configuration and added documentation 2025-08-13 14:51:16 -05:00
rust-toolchain.toml build: normalizing the rust version on nixos 2025-08-13 19:31:12 -05:00

MfGames Conventional Commit

A small utility that calculates the sematic version from conventional commits in a Git repository.

This utility does only two things: calculate the semantic version from Git commits that conform to the conventional commit specification and provide a lightweight way of running scripts when it changes. It is path-aware which means only commits inside certain directories are included in the calculation. The current version number is built from the highest sematic version tag found in the commit's parents.

For example, the version of "Package1" will be 1.2.4 and "Package2" will be 1.3.0 from the following commits:

$ git log --name-only # filter out unimportant bits
    fix: fixing package1

src/package1/file1.txt

    feat: fixing package2

src/package2/file2.txt

    fix: sweeping change

src/package1/file.txt
src/package2/file.txt

    feat: current version # tagged "Package1-1.2.3" and "Package2-1.2.3"

src/package1/file.txt
src/package2/file.txt

In the above example, the second commit is ignored while calculating the "Package1" commits which will have a new version of "1.3.0" because of the "feat" commit. While calculating "Package2", the version will be "1.2.4" because of the "fix" in the second commit because the first is ignored.

If a version cannot be found, this will use 0.0.1.

Documentation

The documentation for the entire project can be found in the ./docs/ folder of this project