aside.version module¶

Manages the package version information.

get_version(commit_tag: Optional[str] = None, short_sha: Optional[str] = None) → str [source]¶

Get the version of the currently installed aside package.

When the commit_tag and short_sha values are not specified, the current version is inferred from pkg_resources or base_version. If the package was not built under official CI, then the string .post0+installed.from.source is appended to the version number.

Parameters

commit_tag – The tag of the currently building commit. It is checked to be matching with the base_version, otherwise a RuntimeError is raised to abort the build.
short_sha – The sha of the currently building commit. If no commit_tag was specified, then this is a development build and the short_sha is appended to the current version using the .post0+sha extension.

Returns

The resulting version string.

base_version: str = '0.1.2'¶: Specifies the semantic version of the package.

version: str¶

Specifies the exact version of the currently installed aside package.

This value is determined from the values of base_version, the pkg_resources distribution version of the current package and the CI_COMMIT_TAG and CI_COMMIT_SHORT_SHA environment variables.

Unlike base_version, version may include extra information for development versions and source installations. See get_version for more info.