build-manylinux.yml

name: ManyLinux

# Run CI only when a release is created, on changes to main branch, or any PR
# to main. Do not run CI on any other branch. Also, skip any non-source changes
# from running on CI
on:
  push:
    branches: main
    paths-ignore:
      - 'docs/**'
      - 'examples/**'
      - '.gitignore'
      - '*.rst'
      - '*.md'
      - '.github/workflows/*.yml'
      # re-include current file to not be excluded
      - '!.github/workflows/build-manylinux.yml'

  pull_request:
    branches: main
    paths-ignore:
      - 'docs/**'
      - 'examples/**'
      - '.gitignore'
      - '*.rst'
      - '*.md'
      - '.github/workflows/*.yml'
      # re-include current file to not be excluded
      - '!.github/workflows/build-manylinux.yml'

  # the github release drafter can call this workflow
  workflow_call:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}-manylinux
  cancel-in-progress: true

jobs:
  build:
    name: ${{ matrix.arch }}
    runs-on: ubuntu-22.04
    permissions:
      contents: read
      packages: write

    strategy:
      fail-fast: false  # if a particular matrix build fails, don't skip the rest
      matrix:
        arch: [x86_64, i686]

    env:
      # load pip config from this file. Define this in 'CIBW_ENVIRONMENT'
      # because this should not affect cibuildwheel machinery
      # also define environment variables needed for testing
      CIBW_ENVIRONMENT: SDL_VIDEODRIVER=dummy SDL_AUDIODRIVER=disk

      CIBW_BUILD: "cp3{8,9,10,11,12}-* pp3{8,9,10}-*"
      CIBW_ARCHS: ${{ matrix.arch }}

      # skip musllinux for now
      CIBW_SKIP: '*-musllinux_*'

      # command that runs before every build
      CIBW_BEFORE_BUILD: |
        pip install -r requirements-dev.txt
        python setup.py docs

      CIBW_TEST_COMMAND: python -m pygame.tests -v --exclude opengl,music,timing --time_out 300

      # To 'solve' this issue:
      #   >>> process 338: D-Bus library appears to be incorrectly set up; failed to read
      #   machine uuid: Failed to open "/var/lib/dbus/machine-id": No such file or directory
      CIBW_BEFORE_TEST: |
        if [ ! -f /var/lib/dbus/machine-id ]; then
            dbus-uuidgen > /var/lib/dbus/machine-id
        fi

      # Increase pip debugging output
      CIBW_BUILD_VERBOSITY: 2

    steps:
    - uses: actions/checkout@v4.1.6

    - name: Log in to the Container registry
      uses: docker/login-action@e92390c5fb421da1463c202d546fed0ec5c39f20
      with:
        registry: ghcr.io
        username: ${{ github.actor }}
        password: ${{ secrets.GITHUB_TOKEN }}

    - name: Inspect image, skip build if image exists
      id: inspect
      continue-on-error: true
      run: docker manifest inspect ghcr.io/${{ github.repository }}_${{ matrix.arch }}:${{ hashFiles('buildconfig/manylinux-build/**') }}

    - name: Extract metadata (tags, labels) for Docker
      id: meta
      uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81
      with:
        images: ghcr.io/${{ github.repository }}_${{ matrix.arch }}
        tags: type=raw,value=${{ hashFiles('buildconfig/manylinux-build/**') }}

    - name: Build and push Docker image
      if: steps.inspect.outcome == 'failure'
      uses: docker/build-push-action@2cdde995de11925a030ce8070c3d77a52ffcf1c0
      with:
        context: ${{ github.workspace }}/buildconfig/manylinux-build/docker_base
        file: ${{ github.workspace }}/buildconfig/manylinux-build/docker_base/Dockerfile-${{ matrix.arch }}
        push: true
        tags: ${{ steps.meta.outputs.tags }}
        labels: ${{ steps.meta.outputs.labels }}

    - name: Build and test wheels
      env:
        # set custom pygame images
        CIBW_MANYLINUX_X86_64_IMAGE: ghcr.io/${{ github.repository }}_x86_64:${{ steps.meta.outputs.version }}
        CIBW_MANYLINUX_PYPY_X86_64_IMAGE: ghcr.io/${{ github.repository }}_x86_64:${{ steps.meta.outputs.version }}
        CIBW_MANYLINUX_I686_IMAGE: ghcr.io/${{ github.repository }}_i686:${{ steps.meta.outputs.version }}
        CIBW_MANYLINUX_PYPY_I686_IMAGE: ghcr.io/${{ github.repository }}_i686:${{ steps.meta.outputs.version }}

      uses: pypa/cibuildwheel@v2.17.0

    # We upload the generated files under github actions assets
    - name: Upload dist
      uses: actions/upload-artifact@v4
      with:
        name: pygame-wheels-manylinux-${{ matrix.arch }}
        path: ./wheelhouse/*.whl
        compression-level: 0  # wheels are already zip files, no need for more compression