Adopt hatch-vcs for git-tag-driven versioning

Author: suecharo

.github/workflows/lint.yml

@@ -41,6 +41,8 @@ jobs:
     steps:
       - name: Checkout Code
         uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
 
       - name: Setup uv
         uses: astral-sh/setup-uv@v7

.github/workflows/pytest.yml

@@ -42,6 +42,8 @@ jobs:
     steps:
       - name: Checkout Code
         uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
 
       - name: Setup uv
         uses: astral-sh/setup-uv@v7

.github/workflows/release.yml

@@ -6,37 +6,17 @@ on:
       - "*.*.*"
 
 jobs:
-  validate-version:
-    if: github.repository == 'sapporo-wes/sapporo-service'
-    runs-on: ubuntu-24.04
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v6
-
-      - name: Verify tag matches pyproject.toml version
-        run: |
-          TAG="${GITHUB_REF_NAME}"
-          PKG_VERSION=$(python3 -c "
-          import tomllib
-          with open('pyproject.toml', 'rb') as f:
-              print(tomllib.load(f)['project']['version'])
-          ")
-          if [ "$TAG" != "$PKG_VERSION" ]; then
-            echo "::error::Tag '$TAG' does not match pyproject.toml version '$PKG_VERSION'"
-            exit 1
-          fi
-          echo "Version check passed: $TAG == $PKG_VERSION"
-
   pypi-publish:
     if: github.repository == 'sapporo-wes/sapporo-service'
-    needs: [validate-version]
     runs-on: ubuntu-24.04
     permissions:
       contents: read
       id-token: write
     steps:
       - name: Checkout Code
         uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
 
       - name: Setup uv
         uses: astral-sh/setup-uv@v7
@@ -60,7 +40,6 @@ jobs:
 
   docker-push:
     if: github.repository == 'sapporo-wes/sapporo-service'
-    needs: [validate-version]
     runs-on: ubuntu-24.04
     permissions:
       contents: read

.gitignore

@@ -219,6 +219,7 @@ __marimo__/
 .streamlit/secrets.toml
 
 # Project specific
+sapporo/_version.py
 runs/
 keycloak-data/
 tests/htmlcov/

Dockerfile

@@ -36,6 +36,8 @@ WORKDIR /app
 
 COPY pyproject.toml uv.lock README.md ./
 
+ENV SETUPTOOLS_SCM_PRETEND_VERSION=${VERSION}
+
 # Named volume inherits image permissions on first creation;
 # make writable so arbitrary UID (dev) can run uv commands.
 RUN uv sync --frozen --all-extras && \

docs/development.md

@@ -168,24 +168,22 @@ To bump the spec version:
 
 ### Version Management
 
-- The `version` field in `pyproject.toml` is the single source of truth
+- The git tag is the single source of truth for the package version (`hatch-vcs`)
 - At runtime, the version is obtained via `importlib.metadata.version("sapporo")`
-- Docker image version is injected by CI from the tag name with `--build-arg VERSION=...`
+- Docker image version is injected by CI from the tag name with `--build-arg VERSION=...` and `SETUPTOOLS_SCM_PRETEND_VERSION`
 
 ### Release Steps
 
-1. Update `version` in `pyproject.toml` on the `develop` branch and run `uv lock`
-2. Create a PR from `develop` to `main` and merge
-3. Create a version tag on the `main` branch:
+1. Create a PR to `main` and merge
+2. Create a version tag on the `main` branch and push:
 
    ```bash
    git checkout main && git pull
    git tag X.Y.Z
    git push origin X.Y.Z
    ```
 
-4. The tag push triggers `release.yml` automatically:
-   - Version consistency check (tag == pyproject.toml version)
+3. The tag push triggers `release.yml` automatically:
    - Publish PyPI package (Trusted Publishing)
    - Build and push multi-architecture Docker image (ghcr.io)
    - Create GitHub Release (auto-generated release notes)

pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["hatchling"]
+requires = ["hatchling", "hatch-vcs"]
 build-backend = "hatchling.build"
 
 [project]
 name = "sapporo"
-version = "2.2.0"
+dynamic = ["version"]
 authors = [
     { name = "DDBJ (Bioinformatics and DDBJ Center)", email = "tazro.ohta@chiba-u.jp" },
 ]
@@ -67,6 +67,13 @@ tests = [
 sapporo = "sapporo.app:main"
 sapporo-cli = "sapporo.cli:main"
 
+[tool.hatch.version]
+source = "vcs"
+fallback-version = "0.0.0"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "sapporo/_version.py"
+
 [tool.hatch.build.targets.wheel]
 packages = ["sapporo"]