Skip to main content

Semantic Version

Overview

A small plugin to facilitate the management of the version number, following the Semantic version convention. More details on semver.org.

It also keep track of the number of build you generate, to achieve that, this plugin generate version_data.cfg file to handle data and options. The file is located at the root of the project. The build number can be shown after the version number.

The generated version is also copied in the project setting property : application/config/version

Developped and tested on Godot 4.3 dev2.

Download and installation

Download the project on Gitlab and copy the files in the addons directory.

License

I realease this small peace of code under the MIT License

Usage

Once the plugin is activated, it automatically increase the build number on each build.

All other interactions happens via the menu :

Project > Tools > Semantic Version Each available interaction are described below

version number

increase Major

Increase the major number by 1 Reset Minor, Patch and phase to 0

increase Minor

Increase the minor number by 1 Reset Patch and Phase to 0

increase Patch

Increase the patch number by 1 Reset Phase to 0

increase phase count

Increase the phase number by 1

phases

alpha

Set or disable Alpha state Disable Beta and RC Set the phase number to 0

beta

Set or disable Beta state Disable Alpha and RC Set the phase number to 0

release candidate

Set or disable RC state Disable Beta and Alpha Set the phase number to 0

init & options

init to 0.0.0

Set the version to 0.0.0 and the phase to 0

init phase counter

Reset the phase to 0

show build number

If active, show the build number in parenthesis after the version number. Unchecked by default.

warning

I do not recommend to activate this for teams. The number of build would keep being overwritten by each computers so it would mean nothing.