Merge pull request #167 from GNS-Science/chore/hatch-vcs

- hatch-vcs for dynamic versioning from git tag (v*)
- updated nzhsm-model version to allow disaggregation configs to be verified

Author: chrisdicaprio

.bumpversion.cfg

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Prevent pushing a version tag unless the changelog has a matching entry.
+# Override defaults via env vars: CHANGELOG_PATH, TAG_PREFIX
+CHANGELOG_PATH="${CHANGELOG_PATH:-CHANGELOG.md}"
+TAG_PREFIX="${TAG_PREFIX:-v}"
+
+while read -r local_ref local_sha remote_ref remote_sha; do
+  case "${local_ref}" in
+    refs/tags/${TAG_PREFIX}*)
+      version="${local_ref#refs/tags/${TAG_PREFIX}}"
+      if ! grep -qE "^## \[${version}\]" "${CHANGELOG_PATH}"; then
+        echo "ERROR: ${CHANGELOG_PATH} is missing a '## [${version}]' section for tag ${local_ref#refs/tags/}." >&2
+        echo "Update ${CHANGELOG_PATH}, delete the tag (git tag -d ${local_ref#refs/tags/}), commit, and re-tag." >&2
+        exit 1
+      fi
+      ;;
+  esac
+done
+
+exit 0

.githooks/pre-push

@@ -123,4 +123,7 @@ audit.txt
 .safety-project.ini
 
 # LLM session state
-.llm/.session
+.llm/.session
+
+# generated by hatch-vcs at build / editable-install time
+toshi_hazard_store/_version.py

.gitignore

@@ -1,6 +1,18 @@
 # Changelog
 
-## [2.0.0] Unreleased
+## [2.0.1] 2026-05-11
+### Added
+- hatch-vcs for dynamic versioning from git tag (v*)
+- git hook to enforce git version tag has matching CHANGLOG entry
+
+### Changed
+- updated nzhsm-model version to allow disaggregation configs to be verified
+- `nzshm-model` updated to 0.15.2
+
+### Removed
+- bump2version dev dependency
+
+## [2.0.0] 2026-05-06
 
 ### Added
 - Import disaggregation realizations from OpenQuake

CHANGELOG.md

@@ -19,7 +19,7 @@ uv run tox -e lint          # ruff check + mypy only
 ### Build & Release
 ```bash
 uv build
-bump2version patch   # updates pyproject.toml, __init__.py, creates git tag
+git tag vX.Y.Z       # replace X.Y.Z with the new version; version derived from tag by hatch-vcs
 git push && git push --tags   # triggers PyPI publish via GitHub Actions
 ```
 
@@ -111,7 +111,7 @@ Any new dependency that calls AWS at import time must be accounted for here.
 
 1. Ensure tests pass and `poetry run tox -e format,lint` passes
 2. Update `CHANGELOG.md` with version header (e.g. `## [1.4.1] 2026-02-24`)
-3. `bump2version patch` (or `minor`/`major`) — commits + tags automatically
+3. `git tag vX.Y.Z` (then `git push --tags`) — version is derived from the tag by hatch-vcs
 4. `git push && git push --tags` — GitHub Actions publishes to PyPI
 
 ## Documentation Conventions

CLAUDE.md

@@ -115,9 +115,8 @@ Make sure all your changes are committed (including an entry in CHANGELOG.md).
 Then run:
 
 ```
-$ uv run bump2version patch # possible: major / minor / patch
-$ git push
-$ git push --tags
+$ git tag vX.Y.Z   # replace X.Y.Z with the new version
+$ git push && git push --tags
 ```
 
 GitHub Actions will then deploy to PyPI if tests pass.

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 [project]
 name = "toshi-hazard-store"
-version = "2.0.0"
+dynamic = ["version"]
 
 homepage = "https://github.com/GNS-Science/toshi-hazard-store"
 description = "Library for saving and retrieving NZHSM openquake hazard results with convenience (uses pyarrow with parquet format)."
@@ -27,7 +27,7 @@ dependencies = [
     "nshm-toshi-client>=1.0.1",
     "numpy>=1.24",
     "nzshm-common>=0.8.4",
-    "nzshm-model>=0.13.6",
+    "nzshm-model>=0.15.2",
     "pandas>=2,<3",
     "pathy>=0.11.0",
     "pyarrow>=20.0.0",
@@ -79,7 +79,6 @@ doc = [
 ]
 
 dev = [
-    "bump2version>=1.0.1",
     "ipython>=8.11.0",
     "matplotlib>=3.6.3",
     "moto>=4",
@@ -131,5 +130,11 @@ exclude-newer = "1 week"
 exclude-newer-package = {"nzshm-common" = false, "nzshm-model" = false, "nshm-toshi-client" = false}
 
 [build-system]
-requires = ["hatchling"]
+requires = ["hatchling", "hatch-vcs"]
 build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "toshi_hazard_store/_version.py"

pyproject.toml

@@ -2,8 +2,7 @@
 
 __author__ = """GNS Science"""
 __email__ = 'nshm@gns.cri.nz'
-__version__ = '2.0.0'
-
-
 import toshi_hazard_store.model as model
 import toshi_hazard_store.query.hazard_query as query_v3  # alias for clients using deprecated module name
+
+from ._version import __version__