TST: add test that pixi lock file is consistent with pyproject.toml [ci doc]

jklymak · jklymak · commit 9bd10f545da0 · 2026-03-30T10:33:14.000-07:00
diff --git a/.github/workflows/pixi-lock-check.yml b/.github/workflows/pixi-lock-check.yml
@@ -0,0 +1,37 @@
+---
+name: Check pixi lockfile
+# check that pixi.lock is consistent with pyproject.toml and ask user to
+# regenerate and commit if not.
+
+on:
+  pull_request:
+    paths:
+      - pyproject.toml
+      - pixi.lock
+      - .github/workflows/pixi-lock-check.yml
+  push:
+    branches: [main]
+    paths:
+      - pyproject.toml
+      - pixi.lock
+      - .github/workflows/pixi-lock-check.yml
+
+jobs:
+  check-lockfile:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@v0.8.8
+        with:
+          run-install: false
+          manifest-path: pyproject.toml
+
+      - name: Check that pixi.lock is up to date
+        run: |
+          if ! pixi install --locked --manifest-path pyproject.toml; then
+            echo "::error file=pixi.lock::pixi.lock is not consistent with pyproject.toml.  Run 'pixi lock' locally and commit the updated pixi.lock."
+            exit 1
+          fi
