Hatch plugin for CalVer versioning
Project description
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:
Original version | Command | New version |
---|---|---|
2024.07.22 |
hatch version release |
2024.09.16 |
2024.07.22.1 |
hatch version release |
2024.09.16 |
2024.07.22 |
hatch version date,a |
2024.09.16a0 |
2021.01.01 |
hatch version rc |
2021.01.01rc0 |
2024.7.22 |
hatch version patch |
2024.07.22.1 |
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, arelease
bump from2024.07.22.1
no longer results in2024.09.16.1
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hatch_calver-2024.9.26-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 192f4f140b11ec3e766fb4950258ebd1d6651ff4ef867f521793ceb5dc882556 |
|
MD5 | 2ee60d41c8f22f36782de2949832b4e9 |
|
BLAKE2b-256 | 287928e5b3a3f0497927e0d5b7667a67f0d036b48097b205969ff003ec83be42 |