Skip to content

Implement initial Windows CI support for the Python cuda-cccl library. #15091

Implement initial Windows CI support for the Python cuda-cccl library.

Implement initial Windows CI support for the Python cuda-cccl library. #15091

# 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: write
outputs:
base_sha: ${{ steps.export-pr-info.outputs.base_sha }}
pr_number: ${{ steps.export-pr-info.outputs.pr_number }}
workflow: ${{ steps.build-workflow.outputs.workflow }}
matrix_enabled: ${{ steps.export-flags.outputs.matrix_enabled }}
vdc_enabled: ${{ steps.export-flags.outputs.vdc_enabled }}
docs_enabled: ${{ steps.export-flags.outputs.docs_enabled }}
rapids_enabled: ${{ steps.export-flags.outputs.rapids_enabled }}
matx_enabled: ${{ steps.export-flags.outputs.matx_enabled }}
steps:
- name: Export workflow flags
id: export-flags
run: |
output() { echo "$1=$2" | tee -a "${GITHUB_OUTPUT}"; }
output matrix_enabled "${{ !contains(github.event.head_commit.message, '[skip-matrix]') }}"
output vdc_enabled "${{ !contains(github.event.head_commit.message, '[skip-vdc]') }}"
output docs_enabled "${{ !contains(github.event.head_commit.message, '[skip-docs]') }}"
output rapids_enabled "${{ contains(github.event.head_commit.message, '[test-rapids]') }}"
# MatX build OOMs the public github runners used on forks:
output matx_enabled "${{ !contains(github.event.head_commit.message, '[skip-matx]') && github.repository == 'NVIDIA/cccl' }}"
- name: Checkout repo
uses: actions/checkout@v4
with:
persist-credentials: false
- name: Lookup PR info
id: get-pr-info
uses: nv-gha-runners/get-pr-info@main
- name: Export PR info
id: export-pr-info
run: |
echo "base_sha=${{ fromJSON(steps.get-pr-info.outputs.pr-info).base.sha }}" | tee -a "${GITHUB_OUTPUT}"
echo "pr_number=${{ fromJSON(steps.get-pr-info.outputs.pr-info).number }}" | tee -a "${GITHUB_OUTPUT}"
- name: Build workflow
# Skip building the matrix when disabled, but still gather PR info for downstream jobs
if: steps.export-flags.outputs.matrix_enabled == 'true'
id: build-workflow
uses: ./.github/actions/workflow-build
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
pr_number: ${{ steps.export-pr-info.outputs.pr_number }}
allow_override: "true"
inspect_changes_script: 'ci/inspect_changes.sh'
inspect_changes_base_sha: ${{ steps.export-pr-info.outputs.base_sha }}
workflows: ${{ github.repository == 'NVIDIA/cccl' && 'pull_request' || 'pull_request_fork' }}
dispatch-groups-linux-two-stage:
name: ${{ matrix.name }}
if: >-
${{
needs.build-workflow.outputs.matrix_enabled == 'true' &&
toJSON(fromJSON(needs.build-workflow.outputs.workflow)['linux_two_stage']['keys']) != '[]'
}}
needs: build-workflow
permissions:
id-token: write
contents: read
strategy:
fail-fast: false
matrix:
name: ${{ fromJSON(needs.build-workflow.outputs.workflow)['linux_two_stage']['keys'] }}
uses: ./.github/workflows/workflow-dispatch-two-stage-group-linux.yml
with:
pc-array: ${{ toJSON(fromJSON(needs.build-workflow.outputs.workflow)['linux_two_stage']['jobs'][matrix.name]) }}
dispatch-groups-windows-two-stage:
name: ${{ matrix.name }}
if: >-
${{
needs.build-workflow.outputs.matrix_enabled == 'true' &&
toJSON(fromJSON(needs.build-workflow.outputs.workflow)['windows_two_stage']['keys']) != '[]'
}}
needs: build-workflow
permissions:
id-token: write
contents: read
strategy:
fail-fast: false
matrix:
name: ${{ fromJSON(needs.build-workflow.outputs.workflow)['windows_two_stage']['keys'] }}
uses: ./.github/workflows/workflow-dispatch-two-stage-group-windows.yml
with:
pc-array: ${{ toJSON(fromJSON(needs.build-workflow.outputs.workflow)['windows_two_stage']['jobs'][matrix.name]) }}
dispatch-groups-linux-standalone:
name: ${{ matrix.name }}
if: >-
${{
needs.build-workflow.outputs.matrix_enabled == 'true' &&
toJSON(fromJSON(needs.build-workflow.outputs.workflow)['linux_standalone']['keys']) != '[]'
}}
needs: build-workflow
permissions:
id-token: write
contents: read
strategy:
fail-fast: false
matrix:
name: ${{ fromJSON(needs.build-workflow.outputs.workflow)['linux_standalone']['keys'] }}
uses: ./.github/workflows/workflow-dispatch-standalone-group-linux.yml
with:
job-array: ${{ toJSON(fromJSON(needs.build-workflow.outputs.workflow)['linux_standalone']['jobs'][matrix.name]) }}
dispatch-groups-windows-standalone:
name: ${{ matrix.name }}
if: >-
${{
needs.build-workflow.outputs.matrix_enabled == 'true' &&
toJSON(fromJSON(needs.build-workflow.outputs.workflow)['windows_standalone']['keys']) != '[]'
}}
needs: build-workflow
permissions:
id-token: write
contents: read
strategy:
fail-fast: false
matrix:
name: ${{ fromJSON(needs.build-workflow.outputs.workflow)['windows_standalone']['keys'] }}
uses: ./.github/workflows/workflow-dispatch-standalone-group-windows.yml
with:
job-array: ${{ toJSON(fromJSON(needs.build-workflow.outputs.workflow)['windows_standalone']['jobs'][matrix.name]) }}
verify-workflow:
name: Verify and summarize workflow results
if: >-
${{
always() &&
!cancelled() &&
needs.build-workflow.outputs.matrix_enabled == 'true'
}}
needs:
- build-workflow
- dispatch-groups-linux-two-stage
- dispatch-groups-windows-two-stage
- dispatch-groups-linux-standalone
- dispatch-groups-windows-standalone
permissions:
contents: read
pull-requests: write # Posts a comment back to the PR.
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v4
with:
persist-credentials: false
- name: Check workflow success
id: check-workflow
uses: ./.github/actions/workflow-results
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
pr_number: ${{ needs.build-workflow.outputs.pr_number }}
verify-devcontainers:
name: Verify Dev Containers
needs: build-workflow
if: ${{ needs.build-workflow.outputs.vdc_enabled == 'true' }}
permissions:
id-token: write
contents: read
uses: ./.github/workflows/verify-devcontainers.yml
with:
base_sha: ${{ needs.build-workflow.outputs.base_sha }}
docs-build:
name: Build and deploy documentation preview
needs: build-workflow
if: >-
${{
needs.build-workflow.outputs.pr_number &&
needs.build-workflow.outputs.docs_enabled == 'true'
}}
permissions:
contents: write
pull-requests: write
pages: write
uses: ./.github/workflows/build-docs.yml
with:
destination_dir: docs/pr-preview/pr-${{ needs.build-workflow.outputs.pr_number }}
pr_number: ${{ needs.build-workflow.outputs.pr_number }}
build-rapids:
name: Build RAPIDS (optional)
needs: build-workflow
if: ${{ needs.build-workflow.outputs.rapids_enabled == 'true' }}
secrets: inherit
permissions:
actions: read
packages: read
id-token: write
contents: read
pull-requests: read
uses: ./.github/workflows/build-rapids.yml
build-matx:
name: Build MatX (optional)
needs: build-workflow
if: ${{ needs.build-workflow.outputs.matx_enabled == 'true' }}
secrets: inherit
permissions:
id-token: write
contents: read
uses: ./.github/workflows/build-matx.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-workflow
- verify-workflow
- verify-devcontainers
- docs-build
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}}"
check_result "docs-build" "success" "${{needs.docs-build.result}}"
if [[ "$status" != "success" ]]; then
exit 1
fi