Skip to content

Latest commit

 

History

History
99 lines (69 loc) · 2.25 KB

update_version.md

File metadata and controls

99 lines (69 loc) · 2.25 KB
Raw

Updating Version File

Version file (include/VERSION) can be updated using the update_version.md script.

The script captures the logic of updating the version file incorporating the common actions and workflow checks.

Usage

Use --help to get the information about actions available as sub-commands:

./utils/update_version.py --help

Some sub-commands have short documentation on their own:

./utils/update_version.py minor --help

All commands return YAML output on success and return non-zero return code on failure.

Examples

Checking Current Status

The status command prints content of the version file as YAML and adds today's date and constructs a version string:

./utils/update_version.py status

Example output:

today: 2022-04-27
year: 2022
major: 3
minor: 2
micro: 0dev
version: 3.2.0dev

Naturally, this also checks that the version if is accessible and fails otherwise.

The status command prints input for Bash eval with --bash:

eval `./utils/update_version.py status --bash`
echo $VERSION

Updating Minor Version

Let's say we are at development-only version 3.1.dev and just created a new branch for 3.2 release, so we want to update the minor version to the next minor version:

./utils/update_version.py minor

Separately, or as part of other changes, now is the time to commit, so the script suggests a commit message:

message: Use the provided title as a commit message
title: 'version: Start 3.2.0dev'

Error Handling

The commands detect invalid states and report error messages. Continuing in the previous example, an attempt to increase the micro version will fail:

./utils/update_version.py micro

The error message explains the reason, a micro version should be increased only after the release:

Already dev with micro '0dev'. Release first before update.

Updating Development-only Version

Development-only versions have odd minor version numbers and are never actually released. Given the branching model, all these versions are on the main branch, so there the minor version is increased by two. This can be done by running the minor command twice or by using the minor --dev:

./utils/update_version.py minor --dev