build: embed source git commit in built package

.gitignore

@@ -43,3 +43,8 @@ samples/**/entry-points.json
 samples/**/uv.lock
 
 testcases/**/uv.lock
+
+# Generated at build time by packages/*/hatch_build.py
+packages/uipath-core/src/uipath/core/_version.py
+packages/uipath-platform/src/uipath/platform/_version.py
+packages/uipath/src/uipath/_version.py

packages/uipath-core/hatch_build.py

@@ -0,0 +1,90 @@
+"""Hatch build hook that stamps the source git commit into the built package.
+
+Writes the file named by ``version-file`` in ``[tool.hatch.build.hooks.custom]``
+using the setuptools-scm / hatch-vcs convention (``__version__`` and
+``__commit_id__``), so an installed package can report the exact commit it was
+built from::
+
+    from <package>._version import __commit_id__
+
+The file is generated at build time and git-ignored. The commit comes from
+``git rev-parse HEAD`` when building from a checkout of this repo. When there is
+no checkout (e.g. building a wheel from an sdist), the commit already recorded
+in the file is kept. If neither is available, ``__commit_id__`` is ``None``.
+"""
+
+import ast
+import subprocess
+from pathlib import Path
+from typing import Any
+
+from hatchling.builders.config import BuilderConfig
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+TEMPLATE = '''\
+"""Version and source commit of this build. Generated by hatch_build.py."""
+
+__all__ = ["__version__", "__commit_id__", "version", "commit_id"]
+
+__version__ = version = {version!r}
+__commit_id__ = commit_id = {commit_id!r}
+'''
+
+
+class CommitIdBuildHook(BuildHookInterface[BuilderConfig]):
+    """Generate the version file before each build."""
+
+    PLUGIN_NAME = "custom"
+
+    def initialize(self, version: str, build_data: dict[str, Any]) -> None:
+        """Write the version file and ship it despite it being git-ignored."""
+        relative_path = self.config["version-file"]
+        version_file = Path(self.root) / relative_path
+        commit_id = _git_commit(Path(self.root)) or _recorded_commit(version_file)
+        version_file.write_text(
+            TEMPLATE.format(version=self.metadata.version, commit_id=commit_id),
+            encoding="utf-8",
+        )
+        build_data["artifacts"].append(f"/{relative_path}")
+
+
+def _git_commit(root: Path) -> str | None:
+    """Return HEAD's full SHA if ``root`` is tracked in a git checkout."""
+    try:
+        # Confirms root belongs to this repo, not to an unrelated parent checkout.
+        subprocess.run(
+            ["git", "ls-files", "--error-unmatch", "pyproject.toml"],
+            cwd=root,
+            check=True,
+            capture_output=True,
+        )
+        result = subprocess.run(
+            ["git", "rev-parse", "HEAD"],
+            cwd=root,
+            check=True,
+            capture_output=True,
+            text=True,
+        )
+    except (OSError, subprocess.CalledProcessError):
+        return None
+    return result.stdout.strip() or None
+
+
+def _recorded_commit(version_file: Path) -> str | None:
+    """Return the commit already in ``version_file`` (e.g. one shipped in an sdist)."""
+    try:
+        tree = ast.parse(version_file.read_text(encoding="utf-8"))
+    except (OSError, SyntaxError):
+        return None
+    for node in tree.body:
+        if (
+            isinstance(node, ast.Assign)
+            and any(
+                isinstance(t, ast.Name) and t.id == "__commit_id__"
+                for t in node.targets
+            )
+            and isinstance(node.value, ast.Constant)
+            and isinstance(node.value.value, str)
+        ):
+            return node.value.value
+    return None

packages/uipath-core/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-core"
-version = "0.5.33"
+version = "0.5.34"
 description = "UiPath Core abstractions"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"
@@ -44,8 +44,12 @@ dev = [
   "pytest-cov>=4.1.0",
   "pytest-mock>=3.11.1",
   "pre-commit>=4.1.0",
+  "hatchling",
 ]
 
+[tool.hatch.build.hooks.custom]
+version-file = "src/uipath/core/_version.py"
+
 [tool.hatch.build.targets.wheel]
 packages = ["src/uipath"]
 

packages/uipath-platform/hatch_build.py

@@ -0,0 +1,90 @@
+"""Hatch build hook that stamps the source git commit into the built package.
+
+Writes the file named by ``version-file`` in ``[tool.hatch.build.hooks.custom]``
+using the setuptools-scm / hatch-vcs convention (``__version__`` and
+``__commit_id__``), so an installed package can report the exact commit it was
+built from::
+
+    from <package>._version import __commit_id__
+
+The file is generated at build time and git-ignored. The commit comes from
+``git rev-parse HEAD`` when building from a checkout of this repo. When there is
+no checkout (e.g. building a wheel from an sdist), the commit already recorded
+in the file is kept. If neither is available, ``__commit_id__`` is ``None``.
+"""
+
+import ast
+import subprocess
+from pathlib import Path
+from typing import Any
+
+from hatchling.builders.config import BuilderConfig
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+TEMPLATE = '''\
+"""Version and source commit of this build. Generated by hatch_build.py."""
+
+__all__ = ["__version__", "__commit_id__", "version", "commit_id"]
+
+__version__ = version = {version!r}
+__commit_id__ = commit_id = {commit_id!r}
+'''
+
+
+class CommitIdBuildHook(BuildHookInterface[BuilderConfig]):
+    """Generate the version file before each build."""
+
+    PLUGIN_NAME = "custom"
+
+    def initialize(self, version: str, build_data: dict[str, Any]) -> None:
+        """Write the version file and ship it despite it being git-ignored."""
+        relative_path = self.config["version-file"]
+        version_file = Path(self.root) / relative_path
+        commit_id = _git_commit(Path(self.root)) or _recorded_commit(version_file)
+        version_file.write_text(
+            TEMPLATE.format(version=self.metadata.version, commit_id=commit_id),
+            encoding="utf-8",
+        )
+        build_data["artifacts"].append(f"/{relative_path}")
+
+
+def _git_commit(root: Path) -> str | None:
+    """Return HEAD's full SHA if ``root`` is tracked in a git checkout."""
+    try:
+        # Confirms root belongs to this repo, not to an unrelated parent checkout.
+        subprocess.run(
+            ["git", "ls-files", "--error-unmatch", "pyproject.toml"],
+            cwd=root,
+            check=True,
+            capture_output=True,
+        )
+        result = subprocess.run(
+            ["git", "rev-parse", "HEAD"],
+            cwd=root,
+            check=True,
+            capture_output=True,
+            text=True,
+        )
+    except (OSError, subprocess.CalledProcessError):
+        return None
+    return result.stdout.strip() or None
+
+
+def _recorded_commit(version_file: Path) -> str | None:
+    """Return the commit already in ``version_file`` (e.g. one shipped in an sdist)."""
+    try:
+        tree = ast.parse(version_file.read_text(encoding="utf-8"))
+    except (OSError, SyntaxError):
+        return None
+    for node in tree.body:
+        if (
+            isinstance(node, ast.Assign)
+            and any(
+                isinstance(t, ast.Name) and t.id == "__commit_id__"
+                for t in node.targets
+            )
+            and isinstance(node.value, ast.Constant)
+            and isinstance(node.value.value, str)
+        ):
+            return node.value.value
+    return None

packages/uipath-platform/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-platform"
-version = "0.2.34"
+version = "0.2.35"
 description = "HTTP client library for programmatic access to UiPath Platform"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"
@@ -48,8 +48,12 @@ dev = [
   "pytest-cov>=4.1.0",
   "pytest-mock>=3.11.1",
   "pre-commit>=4.1.0",
+  "hatchling",
 ]
 
+[tool.hatch.build.hooks.custom]
+version-file = "src/uipath/platform/_version.py"
+
 [tool.hatch.build.targets.wheel]
 packages = ["src/uipath"]