CI: fail CI if lockfile is out of sync with project (#3639)

We also want to automate the updating of the lockfile, but I think this
also helps make sure that they're always in sync before merging, in case
someone updates the dependency locally.

The version overloading is related to this issue in uv, which is that it
doesn't have an official mechanism to support dynamic versions:
astral-sh/uv#7533

.github/workflows/ci-lockfile.yml

@@ -0,0 +1,38 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: CI - Lockfile
+
+on:
+  # Trigger the workflow on push or pull request,
+  # but only for the master branch
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.12']
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+      with:
+        enable-cache: true
+        cache-dependency-glob: "uv.lock"
+
+    - name: Set up Python ${{ matrix.python-version }}
+      run: uv python install ${{ matrix.python-version }}
+
+    - name: Install the package locally and check for lockfile mismatch
+      run: |
+        # Install all default extras.
+        # Fail if the lockfile dependencies are out of date with pyproject.toml.
+        XDSL_VERSION_OVERRIDE="0+dynamic" uv sync --extra gui --extra dev --extra jax --extra riscv --locked

Makefile

@@ -26,7 +26,7 @@ uv-installed:
 # set up the venv with all dependencies for development
 .PHONY: ${VENV_DIR}/
 ${VENV_DIR}/: uv-installed
-	uv sync ${VENV_EXTRAS}
+	XDSL_VERSION_OVERRIDE="0+dynamic" uv sync ${VENV_EXTRAS}
 
 # make sure `make venv` also works correctly
 .PHONY: venv

setup.py

@@ -1,12 +1,19 @@
+import os
 from collections.abc import Mapping
 from typing import cast
 
 from setuptools import Command, find_packages, setup
 
 import versioneer
 
+if "XDSL_VERSION_OVERRIDE" in os.environ:
+    version = os.environ["XDSL_VERSION_OVERRIDE"]
+else:
+    version = versioneer.get_version()
+
+
 setup(
-    version=versioneer.get_version(),
+    version=version,
     cmdclass=cast(Mapping[str, type[Command]], versioneer.get_cmdclass()),
     packages=find_packages(),
 )