.png)
5 hours ago
2
This is a language agnostic git versioning tool using tags.
There are plenty of tools available that can generate a version based on Git tags. However, they are typically:
- driven by commit messages, not configuration
- dependent on programming languages
I didn't want to have to introduce a programming language into my pipeline, especially when it was a language that had absolutely nothing to do with my pipeline, e.g. using an action implemented in JS in a Python project. I also didn't feel like commit messages were the way to go, typos happen, and then someone needs to go and update it manually.
The aim has been to have a very simple approach at versioning without introducing new dependencies, and for it to be configuration driven.
You can either:
- download this script into your pipeline
- use the provided versioner-action
A bash script that calculates semantic versions from git tags and branches, with support for feature branch pre-releases.
- Git repository with commit history
- jq command-line JSON processor
- Bash shell
-
Download the script:
curl -sL https://raw.githubusercontent.com/DragosDumitrache/versioner/main/version.sh -o version.sh chmod +x version.sh -
Create version.json in your repository root:
{ "default_branch": "main", "major": "1", "minor": "0", "tag_prefix": "v", "include_v_prefix": true } -
Run the script:
The version.json file supports the following options:
| default_branch | Main branch name | "master" | "main", "master" |
| major | Minimum major version | "0" | "1", "2" |
| minor | Minimum minor version | "0" | "0", "5" |
| tag_prefix | Prefix for git tags | "" | "v", "release-" |
| include_v_prefix | Include v in output | false | true, false |
On your default branch (e.g., main), the script produces clean semantic versions:
On feature branches, the script produces pre-release versions:
When you have uncommitted changes:
If version.json is malformed, the script will use defaults and may produce unexpected results. Validate your JSON:
The script automatically normalizes branch names:
- feature/user-auth → feature-user-auth
- bugfix/fix_login → bugfix-fix-login
- release/v2.0 → release-v2.0
Use version constraints to enforce minimum versions:
Even if your latest tag is v1.5.0, the script will output v2.1.0 to meet the minimum requirements.
- Ensure you're on the correct branch
- Check that commits exist since the last tag
- Verify git history with git log --oneline
- Check version.json syntax with jq . version.json
- Ensure all values are strings: "1" not 1
- Verify tag prefix matches existing tags
- You're not in a git repository
- Run git init and make at least one commit
- Ensure .git directory exists
Run the included tests:
MIT
