Merge branch 'maintenance/generic-gha-cibuildwheel' into devel

webknjaz · webknjaz · commit 77c3e6435500 · 2025-06-24T02:57:40.000+02:00
PR #750
diff --git a/.github/workflows/ci-cd.yml b/.github/workflows/ci-cd.yml
@@ -627,41 +627,41 @@ jobs:
     - pre-setup  # transitive, for accessing settings
     strategy:
       matrix:
-        os:
+        runner-vm-os:
         - macos-13
     uses: ./.github/workflows/reusable-cibuildwheel.yml
     with:
-      os: ${{ matrix.os }}
-      wheel-tags-to-skip: >-
-        ${{
-        !fromJSON(needs.pre-setup.outputs.release-requested)
-        && '*_i686
-        *-macosx_universal2
-        *-musllinux_*
-        *-win32
-        *_arm64
-        pp*'
-        || ''
-        }}
+      runner-vm-os: ${{ matrix.runner-vm-os }}
+      timeout-minutes: 9
       source-tarball-name: >-
         ${{ needs.pre-setup.outputs.sdist-artifact-name }}
       dists-artifact-name: >-
         ${{ needs.pre-setup.outputs.dists-artifact-name }}
-      # cython-tracing: >-  # Cython line tracing for coverage collection
-      #   ${{
-      #     (
-      #       github.event_name == 'push'
-      #       && contains(github.ref, 'refs/tags/')
-      #     )
-      #     && 'false'
-      #     || 'true'
-      #   }}
-      cython-tracing: >-  # Cython line tracing for coverage collection
-        ${{
+      # CIBW_CONFIG_SETTINGS: `with-cython-tracing` — for coverage collection
+      # CIBW_ARCHS_MACOS=all x86_64 arm64 universal2
+      environment-variables: |-
+        CIBW_ARCHS_MACOS=native
+
+        CIBW_CONFIG_SETTINGS<<EOF
+        with-cython-tracing=${{
           fromJSON(needs.pre-setup.outputs.profiling-enabled)
           && 'true'
           || 'false'
         }}
+        EOF
+
+        ${{
+          !fromJSON(needs.pre-setup.outputs.release-requested)
+          && 'CIBW_SKIP<<EOF
+          *_i686
+          *-macosx_universal2
+          *-musllinux_*
+          *-win32
+          *_arm64
+          pp*
+        EOF'
+          || ''
+        }}
 
   build-bin-manylinux-tested-arches:
     name: >-
@@ -683,22 +683,35 @@ jobs:
     - pre-setup  # transitive, for accessing settings
     uses: ./.github/workflows/reusable-cibuildwheel.yml
     with:
-      os: ubuntu-latest
-      wheel-tags-to-skip: >-
-        *_i686
-        *-musllinux_*
-        *-*linux_{aarch64,ppc64le,s390x}
-        pp*
+      runner-vm-os: ubuntu-latest
+      timeout-minutes: 9
       source-tarball-name: >-
         ${{ needs.pre-setup.outputs.sdist-artifact-name }}
       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_ARCHS_MACOS=all x86_64 arm64 universal2
+      environment-variables: |-
+        CIBW_ARCHS_MACOS=native
+
+        CIBW_CONFIG_SETTINGS<<EOF
+        with-cython-tracing=${{
           fromJSON(needs.pre-setup.outputs.profiling-enabled)
           && 'true'
           || 'false'
         }}
+        EOF
+
+        ${{
+          !fromJSON(needs.pre-setup.outputs.release-requested)
+          && 'CIBW_SKIP<<EOF
+          *_i686
+          *-musllinux_*
+          *-*linux_{aarch64,ppc64le,s390x}
+          pp*
+        EOF'
+          || ''
+        }}
 
   build-bin-manylinux-odd-arches:
     name: >-
@@ -720,23 +733,39 @@ jobs:
     - pre-setup  # transitive, for accessing settings
     uses: ./.github/workflows/reusable-cibuildwheel.yml
     with:
-      os: ubuntu-latest
-      wheel-tags-to-skip: >-
-        *_i686
-        *-musllinux_*
-        *-*linux_x86_64
-        pp*
+      runner-vm-os: ubuntu-latest
+      timeout-minutes: 70
       source-tarball-name: >-
         ${{ needs.pre-setup.outputs.sdist-artifact-name }}
       dists-artifact-name: >-
         ${{ needs.pre-setup.outputs.dists-artifact-name }}
-      qemu: all
-      cython-tracing: >-  # Cython line tracing for coverage collection
-        ${{
+      qemu: true
+      # CIBW_ARCHS_LINUX: Build emulated architectures if QEMU, else "auto"
+      # CIBW_CONFIG_SETTINGS: `with-cython-tracing` — for coverage collection
+      # CIBW_ARCHS_MACOS=all x86_64 arm64 universal2
+      environment-variables: |-
+        CIBW_ARCHS_LINUX=all
+
+        CIBW_ARCHS_MACOS=native
+
+        CIBW_CONFIG_SETTINGS<<EOF
+        with-cython-tracing=${{
           fromJSON(needs.pre-setup.outputs.profiling-enabled)
           && 'true'
           || 'false'
         }}
+        EOF
+
+        ${{
+          !fromJSON(needs.pre-setup.outputs.release-requested)
+          && 'CIBW_SKIP<<EOF
+          *_i686
+          *-musllinux_*
+          *-*linux_x86_64
+          pp*
+        EOF'
+          || ''
+        }}
 
   build-src:
     name: >-
diff --git a/.github/workflows/reusable-cibuildwheel.yml b/.github/workflows/reusable-cibuildwheel.yml
@@ -13,30 +13,32 @@ on:  # yamllint disable-line rule:truthy
         description: A custom name for the Checks API-reported status
         required: false
         type: string
-      cython-tracing:
-        description: Whether to build Cython modules with line tracing
-        default: '0'
-        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: 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.
@@ -50,11 +52,22 @@ jobs:
       ${{
         inputs.check-name
         && inputs.check-name
-        || format('Build wheels on {0} {1}', inputs.os, inputs.qemu)
+        || format(
+          'Build wheels on {0}{1}',
+          inputs.runner-vm-os,
+          inputs.qemu && ' under QEMU' || ''
+        )
       }}
-    runs-on: ${{ inputs.os }}
-    timeout-minutes: ${{ inputs.qemu && 70 || 9 }}
+    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: |
@@ -85,35 +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.17.0
-      env:
-        # CIBW_ARCHS_MACOS: all x86_64 arm64 universal2
-        CIBW_ARCHS_MACOS: native
-        CIBW_CONFIG_SETTINGS: >-  # Cython line tracing for coverage collection
-          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.runner-vm-os }}-
+          ${{ inputs.qemu && 'qemu-' || '' }}
           ${{ steps.gha-artifact-name.outputs.hash }}
         path: ./wheelhouse/*.whl
 
diff --git a/docs/changelog-fragments/750.contrib.rst b/docs/changelog-fragments/750.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`.