Skip to content

Personal AI, On Personal Devices

Python

Adopt hatch-vcs dynamic versioning (reworks autotag, pypi-publish, desktop) (#538)

Aditya Malikdfa908c35810
diff --git a/.github/workflows/autotag.yml b/.github/workflows/autotag.yml
index 9d29a765..e9f87783 100644
--- a/.github/workflows/autotag.yml
+++ b/.github/workflows/autotag.yml
@@ -21,14 +21,20 @@ jobs:
id: version
run: |
set -euo pipefail
- # Base version is the next patch above whatever is in pyproject.toml.
+ # Base version is the next patch above the latest plain release tag
+ # (vX.Y.Z) reachable from HEAD. pyproject.toml no longer carries a
+ # static version (#526 switched it to hatch-vcs), so the release tag
+ # is the source of truth. `.devN`/`.rcN`/`desktop-*` tags are excluded
+ # so they can't be mistaken for the release base.
# Any future manual `X.Y.Z` release will outrank every `X.Y.Z.devN`
# autotag — PEP 440 sorts dev releases strictly below the final.
- BASE=$(grep -E '^version = "' pyproject.toml | head -1 | sed -E 's/^version = "([^"]+)"/\1/')
- if [[ -z "$BASE" ]]; then
- echo "::error::Could not parse version from pyproject.toml"
+ LATEST_RELEASE=$(git tag --list 'v[0-9]*' --merged HEAD \
+ | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+$' | sort -V | tail -1)
+ if [[ -z "$LATEST_RELEASE" ]]; then
+ echo "::error::No release tag (vX.Y.Z) reachable from HEAD"
exit 1
fi
+ BASE="${LATEST_RELEASE#v}"
MAJOR=$(echo "$BASE" | cut -d. -f1)
MINOR=$(echo "$BASE" | cut -d. -f2)
PATCH=$(echo "$BASE" | cut -d. -f3 | sed -E 's/[^0-9].*$//')
diff --git a/.github/workflows/desktop.yml b/.github/workflows/desktop.yml
index 098649dc..89e7f01a 100644
--- a/.github/workflows/desktop.yml
+++ b/.github/workflows/desktop.yml
@@ -114,6 +114,11 @@ jobs:
steps:
- uses: actions/checkout@v6
+ with:
+ # Full history + tags so the workflow_dispatch fallback in
+ # "Determine release info" can derive the dev version from the
+ # latest release tag (#526).
+ fetch-depth: 0
- name: Install system dependencies (Linux)
if: matrix.platform == 'ubuntu-22.04'
@@ -183,7 +188,16 @@ jobs:
# workflow_dispatch fallback (manual UI dispatch without --ref).
# Derive a PEP 440 dev version aligned with autotag.yml so we
# don't burn the X.Y.Z release-version namespace.
- BASE=$(grep -E '^version = "' pyproject.toml | head -1 | sed -E 's/^version = "([^"]+)"/\1/')
+ # pyproject.toml no longer carries a static version (#526), so the
+ # base comes from the latest plain release tag (vX.Y.Z), matching
+ # autotag.yml. .dev/.rc/desktop-* tags are excluded.
+ LATEST_RELEASE=$(git tag --list 'v[0-9]*' --merged HEAD \
+ | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+$' | sort -V | tail -1)
+ if [[ -z "$LATEST_RELEASE" ]]; then
+ echo "::error::No release tag (vX.Y.Z) reachable from HEAD"
+ exit 1
+ fi
+ BASE="${LATEST_RELEASE#v}"
MAJOR=$(echo "$BASE" | cut -d. -f1)
MINOR=$(echo "$BASE" | cut -d. -f2)
PATCH=$(echo "$BASE" | cut -d. -f3 | sed -E 's/[^0-9].*$//')
diff --git a/.github/workflows/pypi-publish.yml b/.github/workflows/pypi-publish.yml
index 9226bc1d..4cd1bcc7 100644
--- a/.github/workflows/pypi-publish.yml
+++ b/.github/workflows/pypi-publish.yml
@@ -12,6 +12,11 @@ on:
description: 'Tag to publish (e.g. v1.0.2.dev500). Overrides github.ref.'
required: false
type: string
+ dry_run:
+ description: 'Dry run: build + validate, then publish to TestPyPI instead of PyPI (no production upload).'
+ required: false
+ default: false
+ type: boolean
permissions:
contents: read
@@ -67,27 +72,41 @@ jobs:
exit 1
}
- - name: Set version from tag
+ - name: Resolve build version from tag
env:
REF: ${{ steps.ref.outputs.ref }}
run: |
set -euo pipefail
- # Strip leading "v" if present (e.g. v1.0.2.dev500 -> 1.0.2.dev500)
+ # Strip leading "v" (e.g. v1.0.3.dev825 -> 1.0.3.dev825).
VERSION="${REF#v}"
- if [[ -z "$VERSION" ]]; then
- echo "::error::Could not resolve version from ref '$REF'"
+ if ! [[ "$VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+ ]]; then
+ echo "::error::ref '$REF' is not a version tag (expected vX.Y.Z[.devN]); pass -f tag=vX.Y.Z"
exit 1
fi
- sed -i "s/^version = \".*\"/version = \"${VERSION}\"/" pyproject.toml
- # Sanity check the substitution actually took
- grep -q "^version = \"${VERSION}\"" pyproject.toml || {
- echo "::error::sed failed to update pyproject.toml version"
- exit 1
- }
- echo "Building version $VERSION"
+ # pyproject.toml is now dynamic = ["version"] via hatch-vcs (#526), so
+ # there is no static line to sed. setuptools_scm cannot bump custom
+ # `.devN` tags, so we pin the exact build version explicitly — the
+ # published version always equals the pushed tag.
+ echo "SETUPTOOLS_SCM_PRETEND_VERSION=${VERSION}" >> "$GITHUB_ENV"
+ echo "Building version ${VERSION}"
- name: Build package
run: uv build
+ - name: Publish to TestPyPI (dry run)
+ if: ${{ inputs.dry_run }}
+ env:
+ UV_PUBLISH_TOKEN: ${{ secrets.TEST_PYPI_API_TOKEN }}
+ run: |
+ set -euo pipefail
+ if [[ -z "${UV_PUBLISH_TOKEN:-}" ]]; then
+ echo "::warning::TEST_PYPI_API_TOKEN is not set — skipping the TestPyPI upload."
+ echo "Build + twine check passed, which validated version derivation and packaging end to end."
+ echo "To exercise a real upload, add a TEST_PYPI_API_TOKEN secret (or a TestPyPI trusted publisher)."
+ exit 0
+ fi
+ uv publish --publish-url https://test.pypi.org/legacy/
+
- name: Publish to PyPI
+ if: ${{ !inputs.dry_run }}
run: uv publish
diff --git a/pyproject.toml b/pyproject.toml
index 47aca336..92504c29 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,10 +1,10 @@
[build-system]
-requires = ["hatchling"]
+requires = ["hatchling", "hatch-vcs"]
build-backend = "hatchling.build"
[project]
name = "OpenJarvis"
-version = "1.0.2"
+dynamic = ["version"]
description = "OpenJarvis — modular AI assistant backend with composable intelligence primitives"
readme = "README.md"
# Upper bound: numpy 2.2.x (pinned transitively via datasets/pandas) ships no
@@ -154,6 +154,30 @@ Issues = "https://github.com/open-jarvis/OpenJarvis/issues"
jarvis = "openjarvis.cli:main"
openjarvis-eval = "openjarvis.evals.cli:main"
+# Version is derived from git tags by hatch-vcs (see #526). For source/editable
+# checkouts this yields the true `git describe` version (e.g. 1.0.3.dev109+g<sha>)
+# rather than a stale static string. CI release builds override this with
+# SETUPTOOLS_SCM_PRETEND_VERSION so the published version equals the pushed tag.
+#
+# setuptools_scm cannot bump custom `.devN` tags (only `.dev0`), so the autotag
+# `vX.Y.Z.devN` tags are deliberately EXCLUDED from version derivation here; the
+# base is taken from the latest plain release tag (vX.Y.Z) and the dev distance
+# is computed from commit count since that release.
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.version.raw-options]
+tag_regex = '^v(?P<version>[0-9]+\.[0-9]+\.[0-9]+)$'
+git_describe_command = [
+ "git", "describe", "--dirty", "--tags", "--long",
+ "--match", "v[0-9]*", "--exclude", "*dev*", "--exclude", "*rc*", "--exclude", "desktop-*",
+]
+# Builds without a git checkout (e.g. the `COPY src/ src/` Docker stages, which
+# never include .git) can't run `git describe`. Without a fallback that would
+# hard-fail the build. Mirror the runtime sentinel in src/openjarvis/__init__.py.
+# Such builds can inject the real version via SETUPTOOLS_SCM_PRETEND_VERSION.
+fallback_version = "0.0.0+unknown"
+
[tool.hatch.build.targets.wheel]
packages = ["src/openjarvis"]