Nipreps version schemes

This package provides a vcs-versioning plugin for version schemes used by the Nipreps family of projects.

Usage

Add nipreps_versions to your build-system.requires list, e.g.,

[build-system]
requires = [
    "hatchling",
    "hatch-vcs",
    "nipreps_versions",
]
build-backend = "hatchling.build"

Then request the nipreps-calver version scheme:

[tool.hatch.version]
source = "vcs"

[tool.hatch.version.raw-options]
version_scheme = "nipreps-calver"

The scheme can also be used by other vcs-versioning based tools (like setuptools_scm >= 8.0) by referencing the nipreps-calver name in their respective configuration sections:

[tool.setuptools_scm]
version_scheme = "nipreps-calver"

Schemes

Currently, only one versioning scheme is implemented:

nipreps-calver

As described in Releases - Principles,

The basic release form is YY.MINOR.PATCH, so the first minor release of 2020 is 20.0.0, and the first minor release of 2021 will be 21.0.0, whatever the final minor release of 2020 is. A series of releases share a YY.MINOR. prefix, which we refer to as the YY.MINOR.x series. For example, the 20.0.x series contains version 20.0.0, 20.0.1, and any other releases needed.

If the last tag was 22.1.0 and the year remains 2022, the development version is 22.2.0.devN. When the year changes to 2023, the development version will become 23.0.0.devN. If the branch is maint/22.1.x, then the computed version will be 22.1.1.devN. If the branch is rel/22.0.3 (and the last tag for that branch is 22.0.2), then the computed version will be 22.0.3.devN.