Merge branch 'maintenance/generic-gha-cibuildwheel'

webknjaz · webknjaz · commit 3390b153cefb · 2025-06-24T03:02:25.000+02:00
PR #668
diff --git a/.github/workflows/ci-cd.yml b/.github/workflows/ci-cd.yml
@@ -134,52 +134,63 @@ jobs:
     - pre-setup  # transitive, for accessing settings
     strategy:
       matrix:
-        os:
-        - ubuntu
-        - windows
-        - macos
+        runner-vm-os:
+        - ubuntu-latest
+        - windows-latest
+        - macos-latest
         tag:
         - ''
         - 'musllinux'
         exclude:
-        - os: windows
+        - runner-vm-os: windows-latest
           tag: 'musllinux'
-        - os: macos
+        - runner-vm-os: macos-latest
           tag: 'musllinux'
-        - os: ubuntu
+        - runner-vm-os: ubuntu-latest
           tag: >-
            ${{
            (github.event_name != 'push' || github.ref_type != 'tag')
            && 'musllinux' || 'none'
            }}
-    uses: ./.github/workflows/reusable-build-wheel.yml
+    uses: ./.github/workflows/reusable-cibuildwheel.yml
     with:
-      os: ${{ matrix.os }}
-      tag: ${{ matrix.tag }}
-      wheel-tags-to-skip: >-
-        ${{
-        (github.event_name != 'push' || !contains(github.ref, 'refs/tags/'))
-        && '*_i686
-        *-macosx_universal2
-        *-musllinux_*
-        *-win32
-        *_arm64
-        pp*'
-        || (matrix.tag == 'musllinux') && '*-manylinux_* pp*'
-        || '*-musllinux_* pp*'
-        }}
+      check-name: >-
+        Build ${{ matrix.tag }} wheels on ${{ matrix.runner-vm-os }}
+      runner-vm-os: ${{ matrix.runner-vm-os }}
+      timeout-minutes: 11
       source-tarball-name: >-
         ${{ needs.build-pure-python-dists.outputs.sdist-filename }}
       dists-artifact-name: ${{ needs.pre-setup.outputs.dists-artifact-name }}
-      cython-tracing: >-  # Cython line tracing for coverage collection
-        ${{
+      # CIBW_CONFIG_SETTINGS: `with-cython-tracing` — for coverage collection
+      # CIBW_CONFIG_SETTINGS: `pure-python` — force C-extensions
+      environment-variables: |-
+        CIBW_ARCHS_MACOS=x86_64 arm64 universal2
+
+        CIBW_CONFIG_SETTINGS<<EOF
+        pure-python=false
+        with-cython-tracing=${{
           (
             github.event_name == 'push'
             && contains(github.ref, 'refs/tags/')
           )
           && 'false'
           || 'true'
         }}
+        EOF
+
+        CIBW_SKIP<<EOF
+        ${{
+          (github.event_name != 'push' || !contains(github.ref, 'refs/tags/'))
+          && '*_i686
+          *-macosx_universal2
+          *-musllinux_*
+          *-win32
+          *_arm64'
+          || (matrix.tag == 'musllinux') && '*-manylinux_*'
+        || '*-musllinux_*'
+        }}
+        pp*
+        EOF
 
   test:
     name: Test
@@ -412,19 +423,40 @@ jobs:
         tag:
         - ''
         - musllinux
-    uses: ./.github/workflows/reusable-build-wheel.yml
+    uses: ./.github/workflows/reusable-cibuildwheel.yml
     with:
-      qemu: ${{ matrix.qemu }}
-      tag: ${{ matrix.tag }}
-      wheel-tags-to-skip: >-
-        ${{
-        (matrix.tag == 'musllinux')
-        && '*-manylinux_* pp*'
-        || '*-musllinux_* pp*'
-        }}
+      check-name: >-
+        Build ${{ matrix.tag }} wheels for ${{ matrix.qemu }}
+      qemu: true
+      timeout-minutes: 25
       source-tarball-name: >-
         ${{ needs.build-pure-python-dists.outputs.sdist-filename }}
       dists-artifact-name: ${{ needs.pre-setup.outputs.dists-artifact-name }}
+      # CIBW_ARCHS_LINUX: Build emulated architectures if QEMU, else "auto"
+      # CIBW_CONFIG_SETTINGS: `with-cython-tracing` — for coverage collection
+      # CIBW_CONFIG_SETTINGS: `pure-python` — force C-extensions
+      environment-variables: |-
+        CIBW_ARCHS_LINUX=${{ matrix.qemu }}
+
+        CIBW_ARCHS_MACOS=x86_64 arm64 universal2
+
+        CIBW_CONFIG_SETTINGS<<EOF
+        pure-python=false
+        with-cython-tracing=${{
+          (
+            github.event_name == 'push'
+            && contains(github.ref, 'refs/tags/')
+          )
+          && 'false'
+          || 'true'
+        }}
+        EOF
+
+        CIBW_SKIP=${{
+          (matrix.tag == 'musllinux')
+          && '*-manylinux_*'
+          || '*-musllinux_*'
+        }} pp*
 
   deploy:
     name: Deploy
diff --git a/.github/workflows/reusable-cibuildwheel.yml b/.github/workflows/reusable-cibuildwheel.yml
@@ -2,42 +2,43 @@
 
 name: Build wheel
 
-on:
+on:  # yamllint disable-line rule:truthy
   workflow_call:
     inputs:
       dists-artifact-name:
         description: Workflow artifact name containing dists
         required: true
         type: string
-      cython-tracing:
-        description: Whether to build Cython modules with line tracing
-        default: '0'
+      check-name:
+        description: A custom name for the Checks API-reported status
         required: false
         type: string
-      os:
-        description: VM OS to use, without version suffix
-        default: ubuntu
+      environment-variables:
+        description: >-
+          A newline-delimited blob of text with environment variables
+          to be set using `${GITHUB_ENV}`
         required: false
         type: string
       qemu:
-        description: Emulated QEMU architecture
-        default: ''
+        default: false
+        description: >-
+          Whether this job needs to configure QEMU to emulate a foreign
+          architecture before running `cibuildwheel`. Defaults to "false".
         required: false
-        type: string
-      tag:
-        description: Build platform tag wheels
-        default: ''
+        type: boolean
+      runner-vm-os:
+        description: VM OS to use
+        default: ubuntu-latest
         required: false
         type: string
       source-tarball-name:
         description: Sdist filename wildcard
         required: true
         type: string
-      wheel-tags-to-skip:
-        description: Wheel tags to skip building
-        default: ''
-        required: false
-        type: string
+      timeout-minutes:
+        description: Deadline for the job to complete
+        required: true
+        type: number
 
 env:
   FORCE_COLOR: "1"  # Make tools pretty.
@@ -48,24 +49,44 @@ jobs:
 
   build-wheel:
     name: >-
-      Build ${{ inputs.tag }} wheels on ${{ inputs.os }} ${{ inputs.qemu }}
-    runs-on: ${{ inputs.os }}-latest
-    timeout-minutes: ${{ inputs.qemu && 25 || 11 }}
+      ${{
+        inputs.check-name
+        && inputs.check-name
+        || format(
+          'Build wheels on {0}{1}',
+          inputs.runner-vm-os,
+          inputs.qemu && ' under QEMU' || ''
+        )
+      }}
+    runs-on: ${{ inputs.runner-vm-os }}
+    timeout-minutes: ${{ fromJSON(inputs.timeout-minutes) }}
     steps:
+    - name: Export requested job-global environment variables
+      if: inputs.environment-variables != ''
+      env:
+        INPUT_ENVIRONMENT_VARIABLES: ${{ inputs.environment-variables }}
+      run: echo "${INPUT_ENVIRONMENT_VARIABLES}" >> "${GITHUB_ENV}"
+      shell: bash
+
     - name: Compute GHA artifact name ending
       id: gha-artifact-name
       run: |
         from hashlib import sha512
         from os import environ
         from pathlib import Path
+
         FILE_APPEND_MODE = 'a'
+
         inputs_json_str = """${{ toJSON(inputs) }}"""
+
         hash = sha512(inputs_json_str.encode()).hexdigest()
+
         with Path(environ['GITHUB_OUTPUT']).open(
                 mode=FILE_APPEND_MODE,
         ) as outputs_file:
             print(f'hash={hash}', file=outputs_file)
       shell: python
+
     - name: Retrieve the project source from an sdist inside the GHA artifact
       uses: re-actors/checkout-python-sdist@release/v2
       with:
@@ -77,36 +98,16 @@ jobs:
       uses: docker/setup-qemu-action@v3
       with:
         platforms: all
-      id: qemu
-    - name: Prepare emulation
-      if: inputs.qemu
-      run: |
-        # Build emulated architectures only if QEMU is set,
-        # use default "auto" otherwise
-        echo "CIBW_ARCHS_LINUX=${{ inputs.qemu }}" >> "${GITHUB_ENV}"
-      shell: bash
-
-    - name: Skip building some wheel tags
-      if: inputs.wheel-tags-to-skip
-      run: |
-        echo "CIBW_SKIP=${{ inputs.wheel-tags-to-skip }}" >> "${GITHUB_ENV}"
-      shell: bash
 
     - name: Build wheels
       uses: pypa/cibuildwheel@v2.23.3
-      env:
-        CIBW_ARCHS_MACOS: x86_64 arm64 universal2
-        CIBW_CONFIG_SETTINGS: >-  # Cython line tracing for coverage collection
-          pure-python=false
-          with-cython-tracing=${{ inputs.cython-tracing }}
 
     - name: Upload built artifacts for testing and publishing
       uses: actions/upload-artifact@v4
       with:
         name: ${{ inputs.dists-artifact-name }}-
-          ${{ inputs.os }}-
-          ${{ inputs.qemu }}-
-          ${{ inputs.tag }}-
+          ${{ inputs.runner-vm-os }}-
+          ${{ inputs.qemu && 'qemu-' || '' }}
           ${{ steps.gha-artifact-name.outputs.hash }}
         path: ./wheelhouse/*.whl
 
diff --git a/CHANGES/668.contrib.rst b/CHANGES/668.contrib.rst
@@ -0,0 +1,3 @@
+The :file:`reusable-cibuildwheel.yml` workflow has been refactored to
+be more generic and :file:`ci-cd.yml` now holds all the configuration
+toggles -- by :user:`webknjaz`.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+The :file:`reusable-cibuildwheel.yml` workflow has been refactored to
	`2`	+be more generic and :file:`ci-cd.yml` now holds all the configuration
	`3`	+toggles -- by :user:`webknjaz`.