build-dimod.yml

# SPDX-FileCopyrightText: 2026 The RISE Project
# SPDX-License-Identifier: MIT
---
# This workflow is based on upstream's own wheel build setup:
#   https://github.com/dwavesystems/dimod/blob/0.12.22/pyproject.toml
#   https://github.com/dwavesystems/dimod/blob/0.12.22/.circleci/config.yml
name: Build dimod wheels (riscv64)

on:
  workflow_dispatch:
    inputs:
      version:
        description: 'Version glob to (re)build; empty builds every version of docs/packages/dimod.yaml not released yet'
        required: false
        default: ''
  pull_request:
    branches: [main]
    paths:
      - '.github/workflows/build-dimod.yml'
      - 'docs/packages/dimod.yaml'
      - 'patches/dimod/**'
  push:
    branches: [main]
    paths:
      - '.github/workflows/build-dimod.yml'
      - 'docs/packages/dimod.yaml'
      - 'patches/dimod/**'

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

permissions:
  contents: read  # to fetch code (actions/checkout)

env:
  MANYLINUX_RISCV64_IMAGE: quay.io/pypa/manylinux_2_39_riscv64

jobs:
  setup:
    uses: $/.github/workflows/_setup.yml
    with:
      package: dimod
      version: ${{ inputs.version }}

  build_sdist:
    needs: [setup]
    if: needs.setup.outputs.versions != '[]'
    # The sdist packages the source tree plus the vendored filereaderlp sources (checked
    # in, not a submodule). It's architecture-independent, so build it once on x86 instead
    # of burning a scarce riscv runner (CLAUDE.md gotcha 4).
    name: Build dimod ${{ matrix.version }} sdist
    runs-on: ubuntu-latest
    permissions:
      contents: read
    strategy:
      fail-fast: false
      matrix:
        version: ${{ fromJSON(needs.setup.outputs.versions) }}
    env:
      DIMOD_VERSION: ${{ matrix.version }}

    steps:
      - name: Checkout dimod v${{ env.DIMOD_VERSION }}
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
        with:
          repository: dwavesystems/dimod
          ref: ${{ env.DIMOD_VERSION }}
          path: dimod
          persist-credentials: false

      - name: Checkout python-wheels
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
        with:
          path: python-wheels
          persist-credentials: false

      - name: Apply patches
        working-directory: dimod
        run: git apply -v ../python-wheels/patches/dimod/${{ env.DIMOD_VERSION }}/*.patch

      - name: Install Python
        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d  # v10.0.1
        with:
          python-version: '3.12'
          activate-environment: true
          enable-cache: false

      - name: Build sdist
        working-directory: dimod
        run: |
          uv pip install build twine
          python -m build --sdist
          twine check --strict dist/*.tar.gz

      - name: Upload sdist artifact
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7.0.1
        with:
          name: dimod-${{ env.DIMOD_VERSION }}-sdist
          path: dimod/dist/*.tar.gz
          if-no-files-found: error

  build_wheels:
    needs: [setup, build_sdist]
    if: needs.setup.outputs.versions != '[]'
    name: Build dimod ${{ matrix.version }} ${{ matrix.python }}-manylinux_riscv64
    runs-on: ubuntu-24.04-riscv
    permissions:
      contents: read
    strategy:
      fail-fast: false
      matrix:
        version: ${{ fromJSON(needs.setup.outputs.versions) }}
        python: ["cp312", "cp313", "cp314", "cp314t"]
        include:
          # pandas, a tests/requirements.txt dependency, has no riscv64 cp314t wheel yet.
          - python: "cp314t"
            test_skip: "*"

    env:
      DIMOD_VERSION: ${{ matrix.version }}

    steps:
      - name: Download sdist
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c  # v8.0.1
        with:
          name: dimod-${{ env.DIMOD_VERSION }}-sdist
          path: dist/

      - id: sdist_path
        run: echo "path=$(echo dist/*.tar.gz)" >> "$GITHUB_OUTPUT"

      - name: Build wheels
        uses: pypa/cibuildwheel@1828c10ab37f080699c7b81cea34097c684a7074  # v4.2.0
        with:
          package-dir: ${{ steps.sdist_path.outputs.path }}
        env:
          CIBW_BUILD: ${{ matrix.python }}-*
          CIBW_ARCHS: riscv64
          # Upstream itself skips musllinux (`skip = "pp* *musllinux*"` in pyproject.toml);
          # CIBW_BUILD overrides that config wholesale, so repeat the musllinux skip here.
          CIBW_SKIP: '*-musllinux_*'
          CIBW_MANYLINUX_RISCV64_IMAGE: ${{ env.MANYLINUX_RISCV64_IMAGE }}
          CIBW_ENVIRONMENT: >-
            PIP_ONLY_BINARY=numpy
            PIP_PREFER_BINARY=1
            PIP_EXTRA_INDEX_URL=https://pypi.riseproject.dev/simple/
            UV_ONLY_BINARY=numpy
            UV_PREFER_BINARY=1
            UV_EXTRA_INDEX_URL=https://pypi.riseproject.dev/simple/
            UV_INDEX_STRATEGY=unsafe-best-match
          CIBW_TEST_SKIP: ${{ matrix.test_skip }}

      - name: Check the Cython extensions made it into the wheel
        run: |
          python3 - wheelhouse/*.whl <<'EOF'
          import sys, zipfile
          expected = {
              "dimod/binary/cybqm/cybqm_float32", "dimod/binary/cybqm/cybqm_float64",
              "dimod/constrained/cyconstrained", "dimod/constrained/cyexpression",
              "dimod/cylp", "dimod/cyqmbase/cyqmbase_float32", "dimod/cyqmbase/cyqmbase_float64",
              "dimod/cyutilities", "dimod/cyvariables", "dimod/discrete/cydiscrete_quadratic_model",
              "dimod/quadratic/cyqm/cyqm_float32", "dimod/quadratic/cyqm/cyqm_float64",
          }
          for whl in sys.argv[1:]:
              names = zipfile.ZipFile(whl).namelist()
              got = {n.split(".", 1)[0] for n in names if n.endswith(".so")}
              assert got == expected, f"{whl}: got {got}, expected {expected}"
              print(whl, "ok")
          EOF

      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7.0.1
        with:
          name: dimod-${{ env.DIMOD_VERSION }}-${{ matrix.python }}-manylinux_riscv64
          path: ./wheelhouse/*.whl
          if-no-files-found: error

  publish:
    name: Publish dimod ${{ matrix.version }}
    needs: [setup, build_wheels]
    if: needs.setup.outputs.versions != '[]'
    strategy:
      fail-fast: false
      matrix:
        version: ${{ fromJSON(needs.setup.outputs.versions) }}
    permissions:
      contents: write
      pull-requests: write
    uses: $/.github/workflows/_publish-wheel.yml
    secrets:
      app-private-key: ${{ secrets.RISEPROJECT_APP_PRIVATE_KEY }}
    with:
      artifact-pattern: dimod-${{ matrix.version }}-*-manylinux_riscv64