build.yml

# Reusable workflow for building binaries

name: Binaries

on:
  workflow_call:
    inputs:
      linux_builder_repo_and_digest:
        # Use .github/find-container-digest action to get this
        description: |
          Docker repo and image digest of the Linux builder container, or
          empty to skip Linux build
        required: false
        type: string
      macos_enable:
        description: Build macOS binaries
        required: false
        type: boolean
        default: false
      openslide_repo:
        description: Override OpenSlide with this repo
        required: false
        type: string
      openslide_ref:
        description: Override OpenSlide with this openslide_repo ref
        required: false
        type: string
      openslide_bin_repo:
        description: Use openslide-bin from this repo
        required: false
        type: string
        default: openslide/openslide-bin
      openslide_bin_ref:
        description: Use openslide-bin from this ref
        required: false
        type: string
        default: main
      suffix:
        description: Set package version suffix
        required: true
        type: string
      werror:
        description: Fail on build warnings in OpenSlide packages
        required: false
        type: boolean
        default: false
      windows_builder_repo_and_digest:
        # Use .github/find-container-digest action to get this
        description: |
          Docker repo and image digest of the Windows builder container
        required: true
        type: string
    outputs:
      version:
        description: The version of the output artifacts
        value: ${{ jobs.sdist.outputs.version }}

permissions:
  contents: read

jobs:
  sdist:
    name: Source tarball
    runs-on: ubuntu-latest
    container: ${{ inputs.windows_builder_repo_and_digest }}
    outputs:
      archive_base: ${{ steps.prep.outputs.archive_base }}
      archive: ${{ steps.prep.outputs.archive }}
      systems: ${{ steps.systems.outputs.systems }}
      version: ${{ steps.prep.outputs.version }}
    steps:
      - name: Check out repo
        uses: actions/checkout@v6
        with:
          repository: ${{ inputs.openslide_bin_repo }}
          ref: ${{ inputs.openslide_bin_ref }}

      - name: Check out OpenSlide
        if: inputs.openslide_repo != ''
        uses: actions/checkout@v6
        with:
          repository: ${{ inputs.openslide_repo }}
          ref: ${{ inputs.openslide_ref }}
          # make sure "git describe" works
          fetch-depth: 0
          path: override/openslide
          persist-credentials: false
      - name: Collect overrides
        if: inputs.openslide_repo != ''
        run: tar cf build-overrides.tar.zst --zstd override
      - name: Upload overrides
        if: inputs.openslide_repo != ''
        uses: actions/upload-artifact@v7
        with:
          path: build-overrides.tar.zst
          archive: false

      - name: Calculate cache key
        id: cache-key
        run: |
          # glob results are sorted
          sha256=$(cat subprojects/*.wrap | sha256sum - | cut -c1-20)
          echo "sha256=${sha256}" >> $GITHUB_OUTPUT
          # use a fresh cache every year to flush out old sources
          echo "year=$(date +%Y)" >> $GITHUB_OUTPUT
      - name: Cache sources
        uses: actions/cache@v5
        with:
          key: build-packagecache-${{ steps.cache-key.outputs.year }}-${{ steps.cache-key.outputs.sha256 }}
          restore-keys: build-packagecache-${{ steps.cache-key.outputs.year }}-
          path: subprojects/packagecache
      - name: Build source tarball
        run: |
          git config --global --add safe.directory "$GITHUB_WORKSPACE"
          ./bintool sdist -x "${{ inputs.suffix }}"
      - name: Prep archive
        id: prep
        run: |
          version=$(./bintool version -x "${{ inputs.suffix }}")
          echo "version=$version" >> $GITHUB_OUTPUT
          archive_base="openslide-bin-${version}"
          echo "archive_base=$archive_base" >> $GITHUB_OUTPUT
          echo "archive=${archive_base}.tar.gz" >> $GITHUB_OUTPUT
      - name: Upload archive
        uses: actions/upload-artifact@v7
        with:
          path: ${{ steps.prep.outputs.archive }}
          archive: false

      - name: Check source tarball size
        # check after uploading, to aid debugging
        run: |
          size=$(stat -c "%s" "${{ steps.prep.outputs.archive }}")
          if [ $size -gt 104857600 ]; then
              # https://github.com/pypi/warehouse/blob/cf94b41/warehouse/forklift/legacy.py#L77
              echo "Source tarball is $size bytes, which is larger than 100 MiB."
              echo "Reduce the source tarball size, or if needed, maintainers will need to"
              echo "request a larger PyPI file size limit."
              echo "https://pypi.org/help/#file-size-limit"
              exit 1
          fi
      - name: Compute bdist systems
        id: systems
        shell: python
        run: |
          import json, os
          systems = []
          if '${{ inputs.linux_builder_repo_and_digest }}':
              for (arch, runner) in (
                  ('aarch64', 'ubuntu-24.04-arm'),
                  ('x86_64', 'ubuntu-latest')
              ):
                  systems.append({
                      'os': 'linux',
                      'arch': arch,
                      'runner': runner,
                      'container': '${{ inputs.linux_builder_repo_and_digest }}',
                  })
          if ${{ inputs.macos_enable && 1 || 0 }}:
              systems.append({
                  'os': 'macos',
                  'arch': 'arm64-x86_64',
                  'runner': 'macos-latest',
              })
          if '${{ inputs.windows_builder_repo_and_digest }}':
              systems.append({
                  'os': 'windows',
                  'arch': 'x64',
                  'runner': 'ubuntu-latest',
                  'container': '${{ inputs.windows_builder_repo_and_digest }}',
              })
          with open(os.environ['GITHUB_OUTPUT'], 'a') as fh:
              fh.write(f'systems={json.dumps(systems)}\n')

  bdist:
    name: Binaries (${{ matrix.os }}, ${{ matrix.arch }})
    needs: sdist
    strategy:
      matrix:
        include: ${{ fromJson(needs.sdist.outputs.systems) }}
    runs-on: ${{ matrix.runner }}
    container: ${{ matrix.container }}
    steps:
      - name: Install dependencies (macOS)
        if: matrix.os == 'macos'
        run: |
          # https://github.com/actions/setup-python/issues/577
          # https://github.com/q3aiml/ledger/commit/f53b35ae
          brew list -1 | grep python@ | while read formula; do
              brew unlink $formula
              brew link --overwrite $formula
          done
          brew update
          brew install meson nasm
          python3 -m pip install --break-system-packages license-expression
      - name: Download source tarball
        uses: actions/download-artifact@v8
        with:
          name: ${{ needs.sdist.outputs.archive }}
      - name: Unpack source tarball
        run: |
          tar xf "${{ needs.sdist.outputs.archive }}"
          mv "${{ needs.sdist.outputs.archive_base }}"/* .
          rm -r "${{ needs.sdist.outputs.archive_base }}" \
              "${{ needs.sdist.outputs.archive }}"
      - name: Download overrides
        if: inputs.openslide_repo != ''
        uses: actions/download-artifact@v8
        with:
          name: build-overrides.tar.zst
      - name: Unpack overrides
        if: inputs.openslide_repo != ''
        run: |
          if [ "${{ matrix.os }}" = linux ]; then
              # EL 8 tar can't autodetect zstd compression
              zstd="-I zstd"
          fi
          tar xf build-overrides.tar.zst $zstd && rm build-overrides.tar.zst
      - name: Build
        id: build
        run: |
          werror=
          if [ "${{ inputs.werror }}" = true ]; then
              werror="-w"
          fi
          ./bintool bdist -x "${{ inputs.suffix }}" $werror
          archive=$(echo openslide-bin-"${{ needs.sdist.outputs.version }}"-*)
          echo "archive=$archive" >> $GITHUB_OUTPUT
          wheel=$(echo openslide_bin-"${{ needs.sdist.outputs.version }}"-*-*-*.whl)
          echo "wheel=$wheel" >> $GITHUB_OUTPUT
      - name: Upload archive
        uses: actions/upload-artifact@v7
        with:
          path: ${{ steps.build.outputs.archive }}
          archive: false
      - name: Upload wheel
        uses: actions/upload-artifact@v7
        with:
          path: ${{ steps.build.outputs.wheel }}
          archive: false

  finalize:
    name: Finalize
    needs: [sdist, bdist]
    runs-on: windows-latest
    steps:
      - name: Update Python
        uses: actions/setup-python@v6
        with:
          python-version: 3.14
      - name: Download archives
        uses: actions/download-artifact@v8
        with:
          pattern: "openslide[-_]bin-${{ needs.sdist.outputs.version }}*"
          path: archives
          merge-multiple: true
          skip-decompress: true
      - name: Unpack source tarball
        shell: bash
        run: |
          tar xf "archives/openslide-bin-${{ needs.sdist.outputs.version }}.tar.gz"
          mv "openslide-bin-${{ needs.sdist.outputs.version }}"/* .
          rm -r "openslide-bin-${{ needs.sdist.outputs.version }}"
      - name: Report package versions
        shell: bash
        run: |
          shopt -s nullglob
          ./bintool versions \
              "archives/openslide-bin-${{ needs.sdist.outputs.version }}"-*.{tar.xz,zip} \
              >> $GITHUB_STEP_SUMMARY
      - name: Windows smoke test
        shell: bash
        run: |
          ./bintool smoke \
              "archives/openslide-bin-${{ needs.sdist.outputs.version }}-windows-x64.zip" \
              "archives/openslide_bin-${{ needs.sdist.outputs.version }}-py3-none-win_amd64.whl"