Find version automatically based on git tags and commit messages.

Last update: Nov 07, 2021

Overview

GIT-CONVENTIONAL-VERSION

Find version automatically based on git tags and commit messages.

The tool is very specific in its function, so it is very flexible.

You can use it as a part of many different integrations and it will not break your process.

Install

python3 -m pip install git-conventional-version

Usage

Get new bumped final version:

gcv

Get new bumped release candidate version:

gcv --type=rc

Get current (old) version, 0.0.0 if none exists:

gcv --old

Example of CI automation script:

old=$(gcv --old)
new=$(gcv)
# check if version bump would happen
if [ ! $new == $old ]; then
    # if yes, update setup.cfg
    sed -i "s/^version.*/version = $new/g" setup.cfg
    # and commit release
    git add setup.cfg
    git commit -m "$new"
    git tag "$new"
    git push --tags
    git push
fi

Version formats

Tags are equivalent to versions, no suffix or prefix is added or interpreted. Formats follow https://www.python.org/dev/peps/pep-0440/.

Final version

Standard tag is in the format \d+\.\d+\.d+ ie. 1.0.0. It can be divided into major . minor . patch versions.

It is automatically bumped based on commits messages and old version of the same type (look at Git commit message convention below).

Pre-release versions

Pre-release versions bumps are calculated based on last final version, its expected bump and old version of the same pre-release type.

- Release candidate version

Format \d+\.\d+\.d+rc\d+ ie. 1.0.0rc1.

- Developmental version

Format \d+\.\d+\.d+dev\d+ ie. 1.0.0dev1.

Local version

Also, local version can be created from commit sha and old version: \d+\.\d+\.d\+.+ ie. 0.0.0+79ad.

Git commit message convention

Convention is based on https://www.conventionalcommits.org/en/v1.0.0/ (it's good!). At the moment, only the following rules apply (I usually use only these but more can be added easily):

Start commit with 'fix:' or 'fix(.*):' to bump patch version.
Start commit with 'feat:' or 'feat(.*):' to bump minor version.
Include in the commit line with 'breaking change:' to bump major version.

Notices

Automatically handling many types of version tags in git is more complicated than it initially seems like.

Comments

Fix tag comparison (numerical order)

Tag comparison was done using alphabetical ordering instead of numerical ordering. This won't work for releases that uses numbers over 9. Casting each version component to an int will force numerical ordering.

The bug can easily be reproduced by creating a dummy repository and adding tags "0.9.0" and "0.10.0". "0.9.0"will be seen as the latest by error.

opened by sgrimard 0

Find version automatically based on git tags and commit messages.

Related tags

Overview

GIT-CONVENTIONAL-VERSION

Install

Usage

Version formats

Git commit message convention

Notices

You might also like...

Python code to generate and store certificates automatically , using names from a csv file

Python script to launch burp scans automatically

Automatically Generate Rulesets for IIS for Intelligent HTTP/S C2 Redirection

Python utilities for writing cross-version compatible libraries

Create C bindings for python automatically with the help of libclang

An awesome tool to save articles from RSS feed to Pocket automatically.

Nmap script to guess* a GitLab version.

Early version for manipulate Geo localization data trough API REST.

This program organizes automatically files in folders named as file's extension

Comments

Fix tag comparison (numerical order)

Releases(1.0.2)

1.0.2(Oct 30, 2021)

Owner

A workflow management tool for numerical models on the NCI computing systems

Simple collection of GTPS Flood in Python.

Color getter (including method to get random color or complementary color) made out of Python

Utility to add/remove licenses to/from source files

Definitely legit social credit generator with python

Greenery - tools for parsing and manipulating regular expressions

A Random Password Generator made from Python

This code renames subtitle file names to your video files names, so you don't need to rename them manually.

A simple tool to extract python code from a Jupyter notebook, and then run pylint on it for static analysis.

A collection of resources/tools and analyses for the angr binary analysis framework.

A dictionary that can be flattened and re-inflated

Networkx with neo4j back-end

Automatically Generate Rulesets for IIS for Intelligent HTTP/S C2 Redirection

Casefy (/keɪsfaɪ/) is a lightweight Python package to convert the casing of strings

Give you a better view of your Docker registry disk usage.

A repository containing several general purpose Python scripts to automate daily and common tasks.

cpp20.py is a Python script to compile C++20 code using modules.

🔩 Like builtins, but boltons. 250+ constructs, recipes, and snippets which extend (and rely on nothing but) the Python standard library. Nothing like Michael Bolton.

HeadHunter parser

NetConfParser is a tool that helps you analyze the rpcs coming and going from a netconf client to a server