github-actions.yml

name: legate-boost build/test

concurrency:
  group: ci-on-${{ github.event_name }}-from-${{ github.ref_name }}
  cancel-in-progress: true

on:
  push:
    branches:
      - "pull-request/[0-9]+"
      - "main"

env:
  # where conda-build puts files it creates
  RAPIDS_CONDA_BLD_OUTPUT_DIR: /tmp/conda-bld-output
  # where jobs that download conda packages store the local channel
  RAPIDS_LOCAL_CONDA_CHANNEL: /tmp/local-conda-packages

jobs:

  # group together all jobs that must pass for a PR to be merged
  # (for use by branch protections)
  pr-builder:
    # skip on builds from merges to main
    if: github.ref != 'refs/heads/main'
    needs:
      - pre-commit
      - conda-python-build
      - conda-python-tests-cpu
      - conda-python-tests-gpu
      - docs-build
    uses: rapidsai/shared-workflows/.github/workflows/pr-builder.yaml@branch-24.10

  pre-commit:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - uses: pre-commit/action@v3.0.1

  conda-python-build:
    needs:
      - pre-commit
    strategy:
      fail-fast: false
      # available legate-core and cunumeric packages:
      #
      #   * https://anaconda.org/legate/legate-core
      #   * https://anaconda.org/legate/cunumeric
      #
      # Valid set of RAPIDS ci-conda image tags:
      #
      #   * https://hub.docker.com/r/rapidsai/ci-conda/tags
      matrix:
        ARCH:
          - "amd64"
        CUDA_VER:
          - "12.5.1"
        PY_VER:
          - "3.10"
          - "3.11"
          - "3.12"
    runs-on: linux-${{ matrix.ARCH }}-cpu4
    container:
      image: "rapidsai/ci-conda:cuda${{ matrix.CUDA_VER }}-ubuntu22.04-py${{ matrix.PY_VER }}"
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
          # the notebooks and PNG files stored in git LFS aren't necessary for package-building
          lfs: false
      - name: build
        run: |
          ci/build_python.sh
      - name: upload
        uses: actions/upload-artifact@v4
        with:
          name: legate-boost-conda-cuda${{ matrix.CUDA_VER }}-${{ matrix.ARCH }}-py${{ matrix.PY_VER }}
          path: ${{ env.RAPIDS_CONDA_BLD_OUTPUT_DIR }}
          if-no-files-found: error

  conda-python-tests-cpu:
    needs:
      - pre-commit
      - conda-python-build
    strategy:
      fail-fast: false
      matrix:
        include:
          - ARCH: "amd64"
            CUDA_VER: "12.5.1"
            PY_VER: "3.11"
    runs-on: linux-${{ matrix.ARCH }}-cpu16
    container:
      image: "rapidsai/ci-conda:cuda${{ matrix.CUDA_VER }}-ubuntu22.04-py${{ matrix.PY_VER }}"
    steps:
      - name: install git-lfs
        run: |
          conda install --yes \
            -c conda-forge \
              git-lfs
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
          lfs: true
      - name: download conda packages
        uses: actions/download-artifact@v4
        with:
          name: legate-boost-conda-cuda${{ matrix.CUDA_VER }}-${{ matrix.ARCH }}-py${{ matrix.PY_VER }}
          path: ${{ env.RAPIDS_LOCAL_CONDA_CHANNEL }}
          github-token: ${{ secrets.GITHUB_TOKEN }}
          repository: ${{ github.repository }}
          run-id: ${{ github.run_id }}
      - name: test
        run: |
          ci/test_python_cpu.sh

  conda-python-tests-gpu:
    needs:
      - pre-commit
      - conda-python-build
    strategy:
      fail-fast: false
      # As of the last time this was updated, legate-core / cunumeric packages were published for only:
      #
      #  * architectures: amd64 only
      #  * CUDA: >=12.2
      #  * Python: 3.10, 3.11, 3.12
      #
      # Valid set of RAPIDS ci-conda image tags: https://hub.docker.com/r/rapidsai/ci-conda/tags
      matrix:
        include:
          - ARCH: "amd64"
            CUDA_VER: "12.5.1"
            PY_VER: "3.10"
    runs-on: linux-${{ matrix.ARCH }}-gpu-v100-latest-1
    container:
      image: "rapidsai/ci-conda:cuda${{ matrix.CUDA_VER }}-ubuntu22.04-py${{ matrix.PY_VER }}"
      env:
        NVIDIA_VISIBLE_DEVICES: ${{ env.NVIDIA_VISIBLE_DEVICES }}
    steps:
      - name: install git-lfs
        run: |
          conda install --yes \
            -c conda-forge \
              git-lfs
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
          lfs: true
      - name: download conda packages
        uses: actions/download-artifact@v4
        with:
          name: legate-boost-conda-cuda${{ matrix.CUDA_VER }}-${{ matrix.ARCH }}-py${{ matrix.PY_VER }}
          path: ${{ env.RAPIDS_LOCAL_CONDA_CHANNEL }}
          github-token: ${{ secrets.GITHUB_TOKEN }}
          repository: ${{ github.repository }}
          run-id: ${{ github.run_id }}
      - name: test
        run: |
          ci/test_python_gpu.sh

  docs-build:
    needs:
      - conda-python-build
    runs-on: linux-amd64-cpu4
    strategy:
      matrix:
        include:
          - ARCH: amd64
            CUDA_VER: "12.5.1"
            PY_VER: "3.12"
    container:
      image: "rapidsai/ci-conda:cuda${{ matrix.CUDA_VER }}-ubuntu22.04-py${{ matrix.PY_VER }}"
    steps:
      - name: install git-lfs
        run: |
          conda install --yes \
            -c conda-forge \
              git-lfs
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
          lfs: true
      - name: download conda packages
        uses: actions/download-artifact@v4
        with:
          name: legate-boost-conda-cuda${{ matrix.CUDA_VER }}-${{ matrix.ARCH }}-py${{ matrix.PY_VER }}
          path: ${{ env.RAPIDS_LOCAL_CONDA_CHANNEL }}
          github-token: ${{ secrets.GITHUB_TOKEN }}
          repository: ${{ github.repository }}
          run-id: ${{ github.run_id }}
      - name: build docs
        run: |
          ci/build_docs.sh
      - uses: actions/upload-pages-artifact@v3
        with:
          path: docs/build/html

  deploy:
    needs:
      - conda-python-build
      - conda-python-tests-cpu
      - conda-python-tests-gpu
      - docs-build

    # only main branch uploads docs
    if: github.ref == 'refs/heads/main' && github.event_name == 'push'

    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write      # to deploy to Pages
      id-token: write   # to verify the deployment originates from an appropriate source

    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    # Specify runner + deployment step
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4