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.
10 May 26, 2022
26 Jul 18, 2022
99 Dec 13, 2022
85 Jun 29, 2022
1 Jul 25, 2022
10 Nov 12, 2022
120 Dec 5, 2022
1 Nov 14, 2021
1 Jan 7, 2022
2 Jan 20, 2022
1 Mar 31, 2022
6 Jun 08, 2022
2 Jan 07, 2022
4 Dec 29, 2021
1 Apr 18, 2022
1 Dec 12, 2021
1 Oct 11, 2022
13 Nov 25, 2022
1 Oct 30, 2021
4.6k Jan 06, 2023
18 Nov 15, 2021
1 Jan 03, 2022
398 Dec 25, 2022
712 Dec 23, 2022
2 Jan 18, 2022
1.1k Jan 02, 2023
2 Dec 11, 2021
1 Oct 26, 2021