Merge pull request #438 from jumpstarter-dev/backport-435-to-release-0.6

[Backport release-0.6] Init hatch-pin-jumpstarter hook

Author: mangelajo

Makefile

@@ -24,7 +24,7 @@ docs-linkcheck:
 	uv run --isolated --all-packages --group docs $(MAKE) -C docs linkcheck
 
 pkg-test-%: packages/%
-	uv run --isolated --directory $< pytest
+	uv run --isolated --directory $< pytest || [ $$? -eq 5 ]
 
 pkg-mypy-%: packages/%
 	uv run --isolated --directory $< mypy .

__templates__/driver/pyproject.toml.tmpl

@@ -29,9 +29,12 @@ testpaths = ["jumpstarter_driver_${DRIVER_NAME}"]
 asyncio_mode = "auto"
 
 [build-system]
-requires = ["hatchling", "hatch-vcs"]
+requires = ["hatchling", "hatch-vcs", "hatch-pin-jumpstarter"]
 build-backend = "hatchling.build"
 
+[tool.hatch.build.hooks.pin_jumpstarter]
+name = "pin_jumpstarter"
+
 [dependency-groups]
 dev = [
     "pytest-cov>=6.0.0",

packages/hatch-pin-jumpstarter/README.md

@@ -0,0 +1,28 @@
+[project]
+name = "hatch-pin-jumpstarter"
+version = "0.1.0"
+description = "Hatch plugin that pins jumpstarter packages in the monorepo"
+readme = "README.md"
+authors = [
+    { name = "Nick Cao", email = "[email protected]" }
+]
+requires-python = ">=3.11"
+dependencies = [
+    "hatchling>=1.27.0",
+    "packaging>=24.2",
+    "tomli>=2.2.1",
+    "tomli-w>=1.2.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.3.5",
+    "pytest-cov>=6.1.1",
+]
+
+[project.entry-points.hatch]
+pin_jumpstarter = "hatch_pin_jumpstarter"

packages/hatch-pin-jumpstarter/pyproject.toml

@@ -0,0 +1,49 @@
+import os
+from pathlib import Path
+from tempfile import NamedTemporaryFile
+
+import tomli
+import tomli_w
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+from hatchling.plugin import hookimpl
+from packaging.requirements import Requirement
+from packaging.specifiers import SpecifierSet
+
+
+class PinJumpstarter(BuildHookInterface):
+    PLUGIN_NAME = "pin_jumpstarter"
+
+    def initialize(self, version, build_data):
+        if self.target_name != "sdist":
+            return
+
+        pyproject = Path(self.root) / "pyproject.toml"
+
+        with pyproject.open("rb") as f:
+            metadata = tomli.load(f)
+
+        if "project" in metadata and "dependencies" in metadata["project"]:
+            for i, dep in enumerate(metadata["project"]["dependencies"]):
+                req = Requirement(dep)
+                if req.name.startswith("jumpstarter"):
+                    req.specifier &= SpecifierSet(f"=={self.metadata.version}")
+                    metadata["project"]["dependencies"][i] = str(req)
+
+        f = NamedTemporaryFile(delete=False)
+        tomli_w.dump(metadata, f)
+        f.close()
+
+        build_data["__hatch_pin_jumpstarter_tempfile"] = f
+        build_data["force_include"][f.name] = "pyproject.toml"
+
+    def finalize(self, version, build_data, artifact_path):
+        if self.target_name != "sdist":
+            return
+
+        f = build_data["__hatch_pin_jumpstarter_tempfile"]
+        os.unlink(f.name)
+
+
+@hookimpl
+def hatch_register_build_hook():
+    return PinJumpstarter

packages/hatch-pin-jumpstarter/src/hatch_pin_jumpstarter/__init__.py

@@ -50,5 +50,8 @@ source = "vcs"
 raw-options = { 'root' = '../../' }
 
 [build-system]
-requires = ["hatchling", "hatch-vcs"]
+requires = ["hatchling", "hatch-vcs", "hatch-pin-jumpstarter"]
 build-backend = "hatchling.build"
+
+[tool.hatch.build.hooks.pin_jumpstarter]
+name = "pin_jumpstarter"

packages/hatch-pin-jumpstarter/src/hatch_pin_jumpstarter/py.typed

@@ -31,5 +31,8 @@ source = "vcs"
 raw-options = { 'root' = '../../' }
 
 [build-system]
-requires = ["hatchling", "hatch-vcs"]
+requires = ["hatchling", "hatch-vcs", "hatch-pin-jumpstarter"]
 build-backend = "hatchling.build"
+
+[tool.hatch.build.hooks.pin_jumpstarter]
+name = "pin_jumpstarter"

packages/jumpstarter-all/pyproject.toml

@@ -36,5 +36,8 @@ source = "vcs"
 raw-options = { 'root' = '../../' }
 
 [build-system]
-requires = ["hatchling", "hatch-vcs"]
+requires = ["hatchling", "hatch-vcs", "hatch-pin-jumpstarter"]
 build-backend = "hatchling.build"
+
+[tool.hatch.build.hooks.pin_jumpstarter]
+name = "pin_jumpstarter"

packages/jumpstarter-cli-admin/pyproject.toml

@@ -35,5 +35,8 @@ source = "vcs"
 raw-options = { 'root' = '../../' }
 
 [build-system]
-requires = ["hatchling", "hatch-vcs"]
+requires = ["hatchling", "hatch-vcs", "hatch-pin-jumpstarter"]
 build-backend = "hatchling.build"
+
+[tool.hatch.build.hooks.pin_jumpstarter]
+name = "pin_jumpstarter"