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

jklymak · timhoffm · jklymak · commit 63bbd3686564 · 2026-04-01T17:40:17.000-07:00
Apply suggestions from code review

Co-authored-by: Tim Hoffmann &lt;2836374+timhoffm@users.noreply.github.com&gt;
diff --git a/.github/workflows/pixi_tests.yml b/.github/workflows/pixi_tests.yml
@@ -22,13 +22,39 @@ on:
 permissions: {}
 
 jobs:
+  check-lockfile:
+    runs-on: ubuntu-slim
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
+        with:
+          fetch-depth: 1
+          persist-credentials: false
+
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@v0.9.4
+        with:
+          pixi-version: v0.66.0
+          run-install: false
+
+      - 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
+
   pixi-linux-install:
-    runs-on: ubuntu-24.04
+    needs: check-lockfile
+    runs-on: ubuntu-slim
     permissions:
       contents: read
 
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
         with:
           fetch-depth: 0
           persist-credentials: false
@@ -40,15 +66,19 @@ jobs:
           locked: true
           cache: true
           cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
+
       - name: Show pixi info
         run: |
           pixi info
           pixi list
+
       - name: Clean build artifacts
         run: |
           rm -rf build meson-logs meson-private .mesonpy-*
+
       - name: Install Matplotlib editable
         run: pixi run python -m pip install --config-settings=setup-args="-Db_lto=false" --editable .
+
       - name: Smoke test editable install
         run: |
           pixi run python -c "import matplotlib; print(matplotlib.__version__)"
diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst
@@ -201,13 +201,13 @@ setup.
 
    .. tab-item:: pixi environment
 
-      A pixi configuration is included in ``pyproject.toml``.  The environment
-      includes the base Matplotlib dependencies, and documentation and testing
-      dependencies. To install the dependencies::
+      A `pixi`_ configuration is included in ``pyproject.toml``.  In addition
+      to the base Matplotlib dependencies, this environment will included the
+      documentation and testing dependencies. To install the dependencies::
 
         pixi install
 
-      and then to install an editable version on Matplotlib::
+      and then to install an editable version of Matplotlib::
 
          pixi run python -m pip install \
             --no-build-isolation \
@@ -218,22 +218,18 @@ setup.
 
          pixi run python -c "import matplotlib; print(matplotlib.__file__)"
 
-      Note there are some pixi tasks available as shortcuts::
 
-         pixi task list
+      .. tip::
+         We provide some pixi tasks as shortcuts for common development tasks,
+         listed via::
 
-      If you do not want to use ``pixi run`` in front of every command, you can do::
+            pixi task list
 
-         pixi shell
+         If you do not want to use ``pixi run`` in front of every command, run::
 
-      and continue to use pixi as a python environment.
+            pixi shell
 
-      .. note:: do not edit the ``pyproject.toml`` file and commit to the repository, as this
-         will affect all developers.  If you want to change the dependencies, please open an
-         issue or pull request to discuss the change.  If you want a custom ``pixi.toml`` file,
-         you can create one in your home directory, and it will be used instead of the
-         repository one. An example is available in ``tools/pixi.example.toml`` that lists the
-         dependencies needed to build Matplotlib.
+         and continue to use pixi as a python environment.
 
       .. _pixi: https://pixi.prefix.dev/
 
