roboversion

Automated project versioning based on Git repository state.

Author

David Finn: [email protected]

Requirements

• Python 3.6+
• Git

Installation

pip install roboversion

Quickstart

roboversion trivialises versioning for packaging in setup.py:

from setuptools import setup
from roboversion import get_version
...
setup(
	...
	version=str(get_version(alpha_branch='origin/my_alpha_branch')),
	...
)

Beyond tagging release commits as normal, this might be the only time the developer needs to touch versioning for their project at all.

Description

Running this module, or its get_version function, will inspect the specified Git repository state and construct a corresponding PEP440-compliant version.

Base releases are expected to be tagged as PEP440-compliant version strings. If no version tags exist, the base version will be treated as 0.0.0, and the resulting development version will be targeting release 0.0.1.

If prerelease branches are specified (e.g. alpha, beta, release candidate) the output version will reflect this information based on the closest ancestor prerelease branch.

Use

This module can be used as an imported module or directly from the command line.

If no ref is specified as the target, 'HEAD' will be the target ref.

If the ref is tagged with a version, the version will correspond to the tagged version.

If the current branch is a prerelease branch, the version will will be a corresponding prerelease version of the next release.

If the ref is neither a tagged version nor at a prerelease branch, the version will be a development version of the next upstream prerelease branch. If no prerelease branches are specified, the version will be a development version of the next release.

If the ref is in the history of an upstream prerelease branch, the version will be a local version of the last release. This is unlikely to be useful, and probably the result of a misconfiguration.

Detailed descriptions of parameters can be found in the method documentation and by running the module with --help.

Examples

from roboversion import get_version
...
version = get_version()

from roboversion import get_version
...
version = get_version(alpha_branch='origin/my_alpha_branch')

$ roboversion

$ roboversion /path/to/repository

$ roboversion --ref origin/master

$ roboversion --alpha origin/alpha --beta origin/beta --release origin/release --no-auto-local --ref HEAD

$ python -m roboversion --alpha origin/alpha --beta origin/beta --release origin/release --no-auto-local --ref HEAD