Merge pull request #22235 from QuLogic/labeled-wheel

dstansby · web-flow · commit ea3b715617d6 · 2022-01-15T09:59:59.000Z
Run wheel builds on PRs when requested by a label
diff --git a/.github/workflows/cibuildwheel.yml b/.github/workflows/cibuildwheel.yml
@@ -1,15 +1,30 @@
 name: Build CI wheels
 
 on:
+  # Save CI by only running this on release branches or tags.
   push:
     branches:
       - main
       - v[0-9]+.[0-9]+.x
     tags:
       - v*
+  # Also allow running this action on PRs if requested by applying the
+  # "Run cibuildwheel" label.
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - labeled
 
 jobs:
   build_wheels:
+    if: |
+      (
+        github.event.action == 'labeled' &&
+        github.event.label.name == 'Run cibuildwheel'
+      ) ||
+      contains(github.event.pull_request.labels.*.name, 'Run cibuildwheel')
     name: Build wheels on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     env:
diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst
@@ -123,6 +123,8 @@ Labels
 
 * If you have the rights to set labels, tag the PR with descriptive labels.
   See the `list of labels <https://github.com/matplotlib/matplotlib/labels>`__.
+* If the PR makes changes to the wheel building Action, add the
+  "Run cibuildwheel" label to enable testing wheels.
 
 .. _pr-milestones:
 
