Variation of `tool.hatch.version` in Hatch configuration

tool.hatch.version.md

Variation of tool.hatch.version in Hatch configuration

Created at: 2025-04-01

Hatch official

regex

[tool.hatch.version]
source = "regex"
# required
path = "src/pkg/__init__.py"
# optional
pattern = "__version__ = ['\"](?P<version>[^'\"]+)['\"]"

code

[tool.hatch.version]
source = "code"
# required
path = "src/pkg/__init__.py"
# optional
expression = "__version__"
search-paths = ["src"]

env

[tool.hatch.version]
source = "env"
# required
variable = "VERSION"

Hatch unofficial

uv-dynamic-versioning

[tool.hatch.version]
source = "uv-dynamic-versioning"

vcs (hatch-vcs)

[tool.hatch.version]
source = "vcs"
# optional
tag-pattern = '(?P<version>\d+(?:\.\d+){0,2}[^+]*)(?:\+.*)?$'
raw-options = { version_scheme = "release-branch-semver" }
fallback-version = "0.0.0"

versiongit

[tool.hatch.version]
source = "versioningit"
# optional
default-version = "0.0.0+unknown"

[tool.hatch.version.format]  # optional
distance = "{next_version}.dev{distance}+{vcs}{rev}"
dirty = "{version}+dirty"
distance-dirty = "{next_version}.dev{distance}+{vcs}{rev}.dirty"