ci-workflow-pull-request.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: pull_request

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

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

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

jobs:

  # build-workflow:
  #   name: Build workflow from matrix
  #   runs-on: ubuntu-latest
  #   permissions:
  #     contents: read
  #     pull-requests: read
  #   outputs:
  #     workflow: ${{ steps.build-workflow.outputs.workflow }}
  #     workflow_keys: ${{ steps.build-workflow.outputs.workflow_keys }}
  #   steps:
  #     - name: Checkout repo
  #       uses: actions/checkout@v3
  #     - name: Lookup PR info
  #       id: get-pr-info
  #       uses: nv-gha-runners/get-pr-info@main
  #     - name: Build workflow
  #       id: build-workflow
  #       uses: ./.github/actions/workflow-build
  #       with:
  #         skip_tests: ${{ toJSON(contains(github.event.head_commit.message, '[skip-tests]')) }}
  #         inspect_changes_script: ${{ toJSON(!contains(github.event.head_commit.message, '[all-projects]') && 'ci/inspect_changes.sh' || '') }}
  #         inspect_changes_base_sha: ${{ fromJSON(steps.get-pr-info.outputs.pr-info).base.sha }}
  #         workflows: >-
  #           ${{ !contains(github.event.head_commit.message, '[workflow:!pull_request]') && 'pull_request' || '' }}
  #           ${{ contains(github.event.head_commit.message, '[workflow:nightly]') && 'nightly' || '' }}
  #           ${{ contains(github.event.head_commit.message, '[workflow:test]') && 'test' || '' }}

  # run-workflow:
  #   name: ${{ matrix.name }}
  #   needs: build-workflow
  #   permissions:
  #     id-token: write
  #     contents: read
  #   strategy:
  #     fail-fast: false
  #     matrix:
  #       name: ${{ fromJSON(needs.build-workflow.outputs.workflow_keys) }}
  #   uses: ./.github/workflows/workflow-dispatch.yml
  #   with:
  #     name: ${{ matrix.name }}
  #     jobs: ${{ toJSON(fromJSON(needs.build-workflow.outputs.workflow)[matrix.name]) }}

  # # This job acts as a sentry and will fail if any leaf job in the workflow tree fails, as
  # # run-workflow always succeeds. Use this job when checking for successful matrix workflow job completion.
  # verify-workflow:
  #   name: Verify and summarize workflow results
  #   if: ${{ always() && !cancelled() }}
  #   needs:
  #     - build-workflow
  #     - run-workflow
  #   permissions:
  #     contents: read
  #     pull-requests: write # Posts a comment back to the PR.
  #   runs-on: ubuntu-latest
  #   steps:
  #     - name: Checkout repo
  #       uses: actions/checkout@v3

  #     - name: Get Base Branch from PR
  #       id: get-pr-info
  #       uses: nv-gha-runners/get-pr-info@main

  #     - name: Check workflow success
  #       id: check-workflow
  #       uses: ./.github/actions/workflow-results
  #       with:
  #         github_token: ${{ secrets.GITHUB_TOKEN }}
  #         pr_number: ${{ fromJSON(steps.get-pr-info.outputs.pr-info).number }}

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

  build-rapids:
    name: Build RAPIDS
    secrets: inherit
    permissions:
      actions: read
      packages: read
      id-token: write
      contents: read
      pull-requests: read
    uses: ./.github/workflows/build-rapids.yml

  # Check all other job statuses. This job gates branch protection checks.
  ci:
    name: CI
    # !! Important: This job is used for branch protection checks.
    # !! Need to use always() instead of !cancelled() because skipped jobs count as success
    # !! for Github branch protection checks. Yes, really: by default, branch protections
    # !! can be bypassed by cancelling CI. See NVIDIA/cccl#605.
    if: ${{ always() }}
    needs:
      - build-rapids
      # - verify-workflow
      # - verify-devcontainers
    runs-on: ubuntu-latest
    steps:
      - name: Check results
        run: |
          status="success"

          check_result() {
            name=$1
            expected=$2
            result=$3

            echo "Checking if $name job result ('$result') is '$expected'..."
            if [[ "$result" != "$expected" ]]; then
              echo "$name job failed"

              status="failed"
            fi
          }

          check_result "verify-workflow"      "success" "${{needs.verify-workflow.result}}"
          check_result "verify-devcontainers" "success" "${{needs.verify-devcontainers.result}}"

          if [[ "$status" != "success" ]]; then
            exit 1
          fi