Fix release versioning and wheel build cache

Author: apoorvalal

.github/workflows/build.yml

@@ -23,7 +23,23 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+
+      - name: Set release version
+        run: echo "SETUPTOOLS_SCM_PRETEND_VERSION=${GITHUB_REF_NAME#v}" >> "$GITHUB_ENV"
+
+      - name: Cache cibuildwheel downloads
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/cibuildwheel
+            ~/Library/Caches/cibuildwheel
+          key: cibuildwheel-${{ runner.os }}-${{ matrix.python[0] }}-${{ matrix.buildplat[1] }}
+          restore-keys: |
+            cibuildwheel-${{ runner.os }}-${{ matrix.python[0] }}-
+            cibuildwheel-${{ runner.os }}-
 
       - name: Setup micromamba
         uses: mamba-org/setup-micromamba@v2.0.1
@@ -33,6 +49,17 @@ jobs:
           init-shell: bash
           generate-run-shell: true
 
+      - name: Prime cibuildwheel virtualenv cache
+        if: runner.os == 'macOS'
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: |
+          mkdir -p ~/Library/Caches/cibuildwheel
+          curl -fL --retry 5 --retry-all-errors \
+            -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+            -o ~/Library/Caches/cibuildwheel/virtualenv-20.26.2.pyz \
+            https://github.com/pypa/get-virtualenv/raw/20.26.2/public/virtualenv.pyz
+
       - name: Build wheels
         uses: pypa/cibuildwheel@v2.19.0
         env:
@@ -75,6 +102,9 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - name: Set release version
+        run: echo "SETUPTOOLS_SCM_PRETEND_VERSION=${GITHUB_REF_NAME#v}" >> "$GITHUB_ENV"
+
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
@@ -175,4 +205,4 @@ jobs:
               release.upload_asset(f"./wheelhouse/{asset}")
 
           print("Release created and assets uploaded successfully")
-          EOF
+          EOF

meson.build

@@ -1,6 +1,10 @@
 project('pyensmallen',
         ['cpp'],
-        version: '0.3.2',
+        version: run_command(
+          'python3',
+          files('tools/get_version.py'),
+          check: true
+        ).stdout().strip(),
         default_options: ['cpp_std=c++14'])
 
 py = import('python').find_installation(pure: false)

tools/get_version.py

@@ -0,0 +1,84 @@
+#!/usr/bin/env python3
+"""Resolve the package version for Meson builds.
+
+This supports three build contexts:
+
+1. Tagged GitHub Actions builds via ``SETUPTOOLS_SCM_PRETEND_VERSION``.
+2. Source distributions, which include ``PKG-INFO`` with the resolved version.
+3. Git checkouts, using ``setuptools_scm`` directly.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+import os
+import re
+import sys
+
+
+ROOT = Path(__file__).resolve().parents[1]
+
+
+def _version_from_env() -> str | None:
+    version = os.environ.get("SETUPTOOLS_SCM_PRETEND_VERSION")
+    if version:
+        return version
+    return None
+
+
+def _version_from_pkg_info() -> str | None:
+    pkg_info = ROOT / "PKG-INFO"
+    if not pkg_info.exists():
+        return None
+
+    for line in pkg_info.read_text(encoding="utf-8").splitlines():
+        if line.startswith("Version: "):
+            return line.split("Version: ", 1)[1].strip()
+    return None
+
+
+def _version_from_generated_file() -> str | None:
+    version_file = ROOT / "pyensmallen" / "_version.py"
+    if not version_file.exists():
+        return None
+
+    match = re.search(
+        r'^__version__\s*=\s*"([^"]+)"\s*$',
+        version_file.read_text(encoding="utf-8"),
+        re.MULTILINE,
+    )
+    if match:
+        return match.group(1)
+    return None
+
+
+def _version_from_scm() -> str | None:
+    try:
+        from setuptools_scm import get_version
+    except ImportError:
+        return None
+
+    try:
+        return get_version(root=str(ROOT), fallback_version="0.0.0")
+    except Exception:
+        return None
+
+
+def main() -> int:
+    for getter in (
+        _version_from_env,
+        _version_from_pkg_info,
+        _version_from_generated_file,
+        _version_from_scm,
+    ):
+        version = getter()
+        if version:
+            print(version)
+            return 0
+
+    print("0.0.0")
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())