build-bitsandbytes.yml

# SPDX-FileCopyrightText: 2026 The RISE Project
# SPDX-License-Identifier: MIT
---
# Based on upstream's Linux CPU wheel path (the build-cpu/build-wheels jobs, which retag the
# wheel py3-none) and its CPU test job:
#   https://github.com/bitsandbytes-foundation/bitsandbytes/blob/0.50.2/.github/workflows/python-package.yml
#   https://github.com/bitsandbytes-foundation/bitsandbytes/blob/0.50.2/.github/workflows/test-runner.yml
name: Build bitsandbytes wheels (riscv64)

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

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

  build_wheels:
    needs: [setup]
    if: needs.setup.outputs.versions != '[]'
    strategy:
      fail-fast: false
      matrix:
        version: ${{ fromJSON(needs.setup.outputs.versions) }}
    name: Build bitsandbytes ${{ matrix.version }} py3-none-manylinux_riscv64
    runs-on: ubuntu-24.04-riscv
    timeout-minutes: 1440

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

    steps:
      - name: Checkout bitsandbytes ${{ env.BITSANDBYTES_VERSION }}
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
        with:
          repository: bitsandbytes-foundation/bitsandbytes
          ref: ${{ env.BITSANDBYTES_VERSION }}
          persist-credentials: false

      - name: Build wheel
        uses: pypa/cibuildwheel@1828c10ab37f080699c7b81cea34097c684a7074  # v4.2.0
        with:
          output-dir: wheelhouse/
          # CMake's COMPUTE_BACKEND defaults to cpu and libbitsandbytes_cpu.so is
          # ctypes-loaded, so one build serves every interpreter (retagged py3-none below,
          # as upstream's own build-wheels job does).
          only: cp312-manylinux_riscv64
        env:
          CIBW_MANYLINUX_RISCV64_IMAGE: ${{ env.MANYLINUX_RISCV64_IMAGE }}
          CIBW_ENVIRONMENT: PIP_EXTRA_INDEX_URL=https://pypi.riseproject.dev/simple/
          CIBW_TEST_ENVIRONMENT: BNB_TEST_DEVICE=cpu PIP_ONLY_BINARY=numpy,scipy,torch,tokenizers,safetensors,regex,pyyaml
          CIBW_TEST_EXTRAS: test
          CIBW_TEST_SOURCES: tests pyproject.toml
          CIBW_TEST_COMMAND: pytest --durations=100

      - name: Retag the wheel py3-none (libbitsandbytes_cpu.so is ctypes-loaded)
        run: |
          sudo apt-get update -qq
          sudo apt-get install -y -qq --no-install-recommends python3-venv
          python3 -m venv .venv
          . .venv/bin/activate
          pip install -q "wheel>=0.42"
          python3 -m wheel tags --python-tag py3 --abi-tag none --remove wheelhouse/bitsandbytes-*.whl

      - name: Check the wheel carries libbitsandbytes_cpu and a vendored libgomp
        run: |
          python3 - wheelhouse/*.whl <<'EOF'
          import sys, zipfile

          names = zipfile.ZipFile(sys.argv[1]).namelist()
          for want in ("bitsandbytes/libbitsandbytes_cpu.so", "libgomp", "licenses/LICENSE"):
              if not any(want in n for n in names):
                  raise SystemExit(f"error: {want} missing from {sys.argv[1]}")
          print("\n".join(n for n in names if ".so" in n))
          EOF

      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7.0.1
        with:
          name: bitsandbytes-${{ env.BITSANDBYTES_VERSION }}-py3-none-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 (gcc) for bitsandbytes ${{ matrix.version }}
    runs-on: ubuntu-24.04-riscv
    env:
      BITSANDBYTES_VERSION: ${{ matrix.version }}

    steps:
      - name: Collect gcc source RPM from manylinux_riscv64
        uses: riseproject-dev/python-wheels/actions/collect-gpl-sources@main
        with:
          image: ${{ env.MANYLINUX_RISCV64_IMAGE }}
          packages: gcc
          output: gpl-sources.tar

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

  publish:
    name: Publish bitsandbytes ${{ 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: bitsandbytes-${{ matrix.version }}-*-manylinux_riscv64
      gpl-sources-artifact: bitsandbytes-${{ matrix.version }}-gpl-sources
      gpl-sources-description: gcc