hatch-calver

A plugin for hatch to support calendar versioning.

Setup

Add hatch-calver as a build dependency to your project.

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

Then, set tool.hatch.version.scheme to "calver".

[tool.hatch.version]
scheme = "calver"

Configuring the CalVer scheme

You can optionally set calver-scheme to a dot-separated string of parts specified in the calver scheme specification. It defaults to YYYY.MM.DD.

[tool.hatch.version]
scheme = "calver"
calver-scheme = "YY.MM"

Note that your project's versions should conform to the scheme you specify; otherwise, determining where to put e.g. patch versions will be quite ambiguous.

Usage

You can use Hatch's standard versioning commands.

To update your project's version to the current date, run hatch version release (or hatch version date).

As with the regular versioning scheme, you can chain multiple segment updates. The date part of the version will not be updated unless you explicitly specify it.

The CalVer scheme specified for your project specifies which segment of the PEP 440 "release" segments are automatically determined; for instance, for a YYYY.MM.DD scheme, the 4th field of the release segment will be considered the patch field.

In other words, if you specify YYYY.MM.DD as your scheme, and it's the 16th of September 2024:

Version history

2024.9.17

• Initial release

2024.9.26

• Changed the date/release bump instructions to reset any non-date segments. In other words, a release bump from 2024.07.22.1 no longer results in 2024.09.16.1.