stormlog.release_version

Helpers for deriving the next release version from Git tags.

Functions

bump_release_version(version, *[, ...])

Increment a stable version, rolling patch values above the threshold.

format_release_version(version)

Render a version tuple as a dotted version string.

git_release_tags()

Return Git tags that participate in release-version resolution.

main()

Print the next release version for the current Git checkout.

resolve_release_version(tags, *[, ...])

Resolve the next stable release version from existing Git tags.

split_release_tags(tags)

Return stable and prerelease version tuples parsed from Git tags.

stormlog.release_version.split_release_tags(tags)[source]

Return stable and prerelease version tuples parsed from Git tags.

Parameters:

tags (Iterable[str])

Return type:

tuple[list[tuple[int, int, int]], list[tuple[int, int, int]]]

stormlog.release_version.bump_release_version(version, *, patch_rollover=10)[source]

Increment a stable version, rolling patch values above the threshold.

Parameters:
  • version (tuple[int, int, int])

  • patch_rollover (int)

Return type:

tuple[int, int, int]

stormlog.release_version.format_release_version(version)[source]

Render a version tuple as a dotted version string.

Parameters:

version (tuple[int, int, int])

Return type:

str

stormlog.release_version.resolve_release_version(tags, *, patch_rollover=10, default_version='0.1.0')[source]

Resolve the next stable release version from existing Git tags.

Parameters:
  • tags (Iterable[str])

  • patch_rollover (int)

  • default_version (str)

Return type:

str

stormlog.release_version.git_release_tags()[source]

Return Git tags that participate in release-version resolution.

Return type:

list[str]

stormlog.release_version.main()[source]

Print the next release version for the current Git checkout.

Return type:

None