pr.yml

# SPDX-FileCopyrightText: Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# This is the main workflow that runs on every PR and push to main
name: pr

defaults:
  run:
    shell: bash -euo pipefail {0}

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

# Only runs one instance of this workflow at a time for a given PR and cancels any in-progress runs when a new one starts.
concurrency:
  group: ${{ github.workflow }}-on-${{ github.event_name }}-from-${{ github.ref_name }}
  cancel-in-progress: true

permissions:
  contents: read
  pull-requests: read

jobs:
  compute-matrix:
    name: Compute matrix
    runs-on: ubuntu-latest
    outputs:
      DEVCONTAINER_VERSION: ${{steps.set-outputs.outputs.DEVCONTAINER_VERSION}}
      PER_CUDA_COMPILER_MATRIX: ${{steps.set-outputs.outputs.PER_CUDA_COMPILER_MATRIX}}
      PER_CUDA_COMPILER_KEYS: ${{steps.set-outputs.outputs.PER_CUDA_COMPILER_KEYS}}
    steps:
      - name: Checkout repo
        uses: actions/checkout@v4
      - name: Compute matrix outputs
        id: set-outputs
        run: |
          .github/actions/compute-matrix/compute-matrix.sh ci/matrix.yaml pull_request

  nvbench:
    name: NVBench CUDA${{ matrix.cuda_host_combination }}
    permissions:
      id-token: write
      contents: read
    needs: compute-matrix
    uses: ./.github/workflows/dispatch-build-and-test.yml
    strategy:
      fail-fast: false
      matrix:
        cuda_host_combination: ${{ fromJSON(needs.compute-matrix.outputs.PER_CUDA_COMPILER_KEYS) }}
    with:
      project_name: "nvbench"
      per_cuda_compiler_matrix: ${{ toJSON(fromJSON(needs.compute-matrix.outputs.PER_CUDA_COMPILER_MATRIX)[ matrix.cuda_host_combination ]) }}
      devcontainer_version: ${{ needs.compute-matrix.outputs.DEVCONTAINER_VERSION }}
      is_windows: ${{ contains(matrix.cuda_host_combination, 'cl') }}

  verify-devcontainers:
    name: Verify Dev Containers
    permissions:
      id-token: write
      contents: read
    uses: ./.github/workflows/verify-devcontainers.yml

  # This job is the final job that runs after all other jobs and is used for branch protection status checks.
  # See: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks
  # https://github.com/orgs/community/discussions/26822#discussioncomment-5122101
  ci:
    runs-on: ubuntu-latest
    name: CI
    if: ${{ always() }} # need to use always() instead of !cancelled() because skipped jobs count as success
    needs:
      - nvbench
      - verify-devcontainers
    steps:
      - name: Check status of all precursor jobs
        if: >-
          ${{
               contains(needs.*.result, 'failure')
            || contains(needs.*.result, 'cancelled')
            || contains(needs.*.result, 'skipped')
          }}
        run: exit 1