Set rolling package version based on date and github run number.

Author: ScottTodd

.github/workflows/build_packages.yml

@@ -13,9 +13,32 @@ on:
     - cron: '0 11 * * *'
 
 jobs:
+  setup_metadata:
+    runs-on: ubuntu-24.04
+    outputs:
+      shark_package_version: ${{ steps.version.outputs.shark_package_version }}
+    steps:
+      - name: Compute version
+        id: version
+        run: |
+          shark_package_version="$(printf '%(%Y%m%d)T.${{ github.run_number }}')"
+          echo "shark_package_version=${shark_package_version}" >> $GITHUB_OUTPUT
+          cat << EOF > ./version_info.json
+          {
+            "package-version": "${shark_package_version}",
+          }
+          EOF
+          cat ./version_info.json
+      - name: Upload version_info.json
+        uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0
+        with:
+          name: version_info.json
+          path: version_info.json
+
   build_packages:
-    name: "${{ matrix.build-family }} :: ${{ matrix.package }} :: ${{ matrix.python-version }}"
+    name: "${{ matrix.package }} :: ${{ matrix.build-family }} :: ${{ matrix.python-version }}"
     runs-on: ${{ matrix.runs-on }}
+    needs: [setup_metadata]
     strategy:
       fail-fast: false
       matrix:
@@ -29,7 +52,9 @@ jobs:
             build-family: linux-x86_64
             package: shortfin
             python-version: cp313-cp313
+
           # TODO(#130): macOS
+
           # TODO(#130): Windows
 
     steps:
@@ -39,10 +64,14 @@ jobs:
         path: "c" # Windows can hit path length limits, so use a short path.
         submodules: false
 
+    - name: Download version_info.json
+      uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
+      with:
+        name: version_info.json
+        path: version_info.json
 
     - name: Build shortfin (Linux x86_64, ${{ matrix.python-version }})
       if: "matrix.package == 'shortfin' && matrix.build-family == 'linux-x86_64'"
-      shell: bash
       env:
         OUTPUT_DIR: "${{ github.workspace }}/bindist"
         OVERRIDE_PYTHON_VERSIONS: "${{ matrix.python-version }}"
@@ -51,7 +80,7 @@ jobs:
         ./c/shortfin/build_tools/build_linux_package.sh
 
     - name: Upload python wheels
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0
       with:
         if-no-files-found: error
         name: snapshot-${{ matrix.package }}-${{ matrix.build-family }}-${{ matrix.python-version }}
@@ -68,4 +97,4 @@ jobs:
         removeArtifacts: false
         allowUpdates: true
         replacesArtifacts: true
-        makeLatest: true
+        makeLatest: false

shortfin/setup.py

@@ -4,16 +4,17 @@
 # See https://llvm.org/LICENSE.txt for license information.
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
-from distutils.core import setup, Extension
-import sys
+import json
+import os
 import shutil
 import subprocess
-import os
-from pathlib import Path
+import sys
 from distutils.command.build import build as _build
+from distutils.core import setup, Extension
+from pathlib import Path
 from setuptools import find_namespace_packages
-from setuptools.command.build_ext import build_ext as _build_ext
 from setuptools.command.build_py import build_py as _build_py
+from setuptools.command.build_ext import build_ext as _build_ext
 
 
 def get_env_boolean(name: str, default_value: bool = False) -> bool:
@@ -126,11 +127,43 @@ def run(self):
 
 
 class NoopBuildExtension(_build_ext):
-    def build_extension(self, ext):
-        ...
+    def build_extension(self, ext): ...
+
+    def copy_extensions_to_source(self, *args, **kwargs): ...
+
+
+# Setup and get version information.
+VERSION_INFO_FILE = os.path.join(SOURCE_DIR, "version_info.json")
+
+
+def load_version_info():
+    with open(VERSION_INFO_FILE, "rt") as f:
+        return json.load(f)
+
+
+def find_git_version():
+    try:
+        return (
+            subprocess.check_output(["git", "rev-parse", "HEAD"], cwd=SOURCE_DIR)
+            .decode("utf-8")
+            .strip()
+        )
+    except subprocess.SubprocessError as e:
+        print(f"ERROR: Could not get git revision: {e}", file=sys.stderr)
+    return None
+
+
+try:
+    version_info = load_version_info()
+except FileNotFoundError:
+    print("version_info.json not found. Using defaults", file=sys.stderr)
+    version_info = {}
+git_version = find_git_version()
 
-    def copy_extensions_to_source(self, *args, **kwargs):
-        ...
+PACKAGE_SUFFIX = version_info.get("package-suffix") or ""
+PACKAGE_VERSION = version_info.get("package-version")
+if not PACKAGE_VERSION:
+    PACKAGE_VERSION = f"0.dev0+{git_version or '0'}"
 
 
 def maybe_nuke_cmake_cache(cmake_build_dir):
@@ -324,7 +357,7 @@ def populate_built_package(abs_dir):
 
 setup(
     name="shortfin",
-    version="0.9",
+    version=f"{PACKAGE_VERSION}",
     description="Shortfin native library implementation",
     author="SHARK Authors",
     packages=packages,