build-scs.yml

# SPDX-FileCopyrightText: 2026 The RISE Project
# SPDX-License-Identifier: MIT
---
# This workflow is based on: https://github.com/bodono/scs-python/blob/3.2.11/.github/workflows/build.yml
name: Build scs wheels (riscv64)

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

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: scs
      version: ${{ inputs.version }}

  build_wheels:
    needs: [setup]
    if: needs.setup.outputs.versions != '[]'
    name: Build scs ${{ matrix.version }} ${{ matrix.python }}-manylinux_riscv64
    runs-on: ubuntu-24.04-riscv
    timeout-minutes: 180
    strategy:
      fail-fast: false
      matrix:
        version: ${{ fromJSON(needs.setup.outputs.versions) }}
        # cp314t is dropped: numpy and scipy, which scs needs to build and to
        # test, have no free-threaded riscv64 wheels on PyPI or our registry.
        python:
          - "cp312"
          - "cp313"
          - "cp314"

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

    steps:
      - name: Checkout scs ${{ env.SCS_VERSION }}
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
        with:
          repository: bodono/scs-python
          ref: ${{ env.SCS_VERSION }}
          submodules: recursive
          persist-credentials: false

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

      - name: Patch scs source
        run: git apply python-wheels/patches/scs/${{ env.SCS_VERSION }}/*.patch

      - name: Build wheels
        uses: pypa/cibuildwheel@1828c10ab37f080699c7b81cea34097c684a7074  # v4.2.0
        with:
          output-dir: wheelhouse/
          only: ${{ matrix.python }}-manylinux_riscv64
        env:
          CIBW_MANYLINUX_RISCV64_IMAGE: ${{ env.MANYLINUX_RISCV64_IMAGE }}
          # Upstream's per-image before-all, for the riscv64 image; the submodule
          # half is already done by the checkout above. Also stages OpenBLAS'
          # licence, which auditwheel bundles the library without.
          CIBW_BEFORE_ALL_LINUX: >-
            dnf -y install openblas-devel &&
            cp /usr/share/licenses/openblas/LICENSE {project}/LICENSE.openblas
          # numpy (build and test) and scipy (test) have no riscv64 wheels on PyPI.
          CIBW_ENVIRONMENT: >-
            PIP_EXTRA_INDEX_URL=https://pypi.riseproject.dev/simple/
            PIP_ONLY_BINARY=numpy,scipy

      - name: Check the wheel ships the extensions and all licences
        run: |
          python3 - wheelhouse/*.whl <<'EOF'
          import sys, zipfile
          for whl in sys.argv[1:]:
              names = zipfile.ZipFile(whl).namelist()
              for mod in ("_scs_direct", "_scs_indirect"):
                  assert any(n.startswith(f"scs/{mod}.") and n.endswith(".so")
                             for n in names), (whl, mod)
              licences = {n.rsplit("/", 1)[1]
                          for n in names if ".dist-info/licenses/" in n} - {""}
              # 3.3.1 added LICENSE-INTEL-MKL.txt at the repo root, alongside
              # LICENSE; the pyproject.toml patch's LICENSE* glob ships it too.
              assert licences == {"LICENSE", "LICENSE.openblas", "LICENSE-INTEL-MKL.txt"}, (whl, licences)
              print(whl, "ok")
          EOF

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

  gpl_sources:
    needs: [setup]
    if: needs.setup.outputs.versions != '[]'
    strategy:
      fail-fast: false
      matrix:
        version: ${{ fromJSON(needs.setup.outputs.versions) }}
    name: Collect GPL sources
    runs-on: ubuntu-24.04-riscv

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

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

      # OpenBLAS is compiled with gfortran, so auditwheel vendors the image's
      # libgfortran into scs.libs/.
      - uses: ./actions/collect-gpl-sources
        with:
          image: ${{ env.MANYLINUX_RISCV64_IMAGE }}
          packages: gcc
          output: gpl-sources.tar

      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7.0.1
        with:
          name: scs-${{ env.SCS_VERSION }}-gpl-sources
          path: gpl-sources.tar
          if-no-files-found: error

  publish:
    name: Publish scs ${{ matrix.version }}
    needs: [setup, build_wheels, gpl_sources]
    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: scs-${{ matrix.version }}-*-manylinux_riscv64
      gpl-sources-artifact: scs-${{ matrix.version }}-gpl-sources
      gpl-sources-description: gcc