Skip to content

CI: Add doc-only support to skip tests and non-essential builds #1478

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Andy-Jost merged 3 commits into from
Jan 14, 2026
+29 −10
Merged

CI: Add doc-only support to skip tests and non-essential builds #1478

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a5d6651
CI: Add [doc-only] support to skip tests and non-essential builds
Andy-Jost Jan 13, 2026
cb34189
Merge branch 'main' into doc-only-ci
Andy-Jost Jan 14, 2026
4eba160
Merge branch 'main' into doc-only-ci
Andy-Jost Jan 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 29 additions & 10 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ jobs:
runs-on: ubuntu-latest
outputs:
skip: ${{ steps.get-should-skip.outputs.skip }}
doc-only: ${{ steps.get-should-skip.outputs.doc_only }}
steps:
- name: Checkout repository
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
Expand All @@ -50,11 +51,16 @@ jobs:
run: |
set -euxo pipefail
if ${{ startsWith(github.ref_name, 'pull-request/') }}; then
skip="$(gh pr view "$(grep -Po '(\d+)$' <<< '${{ github.ref_name }}')" --json title --jq '.title | contains("[no-ci]")')"
pr_number="$(grep -Po '(\d+)$' <<< '${{ github.ref_name }}')"
pr_title="$(gh pr view "${pr_number}" --json title --jq '.title')"
skip="$(echo "${pr_title}" | grep -q '\[no-ci\]' && echo true || echo false)"
doc_only="$(echo "${pr_title}" | grep -q '\[doc-only\]' && echo true || echo false)"
else
skip=false
doc_only=false
fi
echo "skip=${skip}" >> "$GITHUB_OUTPUT"
echo "doc_only=${doc_only}" >> "$GITHUB_OUTPUT"

# WARNING: make sure all of the build jobs are in sync
Copy link
Member

@leofang leofang Jan 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this particular job needs to stay intact. Let's update this warning to explain why it's out of sync from other build jobs below.

Copy link
Contributor Author

@Andy-Jost Andy-Jost Jan 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does "in sync" here mean the code blocks follow a parallel structure?

build-linux-64:
Expand Down Expand Up @@ -86,7 +92,7 @@ jobs:
host-platform:
- linux-aarch64
name: Build ${{ matrix.host-platform }}, CUDA ${{ needs.ci-vars.outputs.CUDA_BUILD_VER }}
if: ${{ github.repository_owner == 'nvidia' && !fromJSON(needs.should-skip.outputs.skip) }}
if: ${{ github.repository_owner == 'nvidia' && !fromJSON(needs.should-skip.outputs.skip) && !fromJSON(needs.should-skip.outputs.doc-only) }}
secrets: inherit
uses: ./.github/workflows/build-wheel.yml
with:
Expand All @@ -105,7 +111,7 @@ jobs:
host-platform:
- win-64
name: Build ${{ matrix.host-platform }}, CUDA ${{ needs.ci-vars.outputs.CUDA_BUILD_VER }}
if: ${{ github.repository_owner == 'nvidia' && !fromJSON(needs.should-skip.outputs.skip) }}
if: ${{ github.repository_owner == 'nvidia' && !fromJSON(needs.should-skip.outputs.skip) && !fromJSON(needs.should-skip.outputs.doc-only) }}
secrets: inherit
uses: ./.github/workflows/build-wheel.yml
with:
Expand All @@ -121,11 +127,12 @@ jobs:
host-platform:
- linux-64
name: Test ${{ matrix.host-platform }}
if: ${{ github.repository_owner == 'nvidia' }}
if: ${{ github.repository_owner == 'nvidia' && !fromJSON(needs.should-skip.outputs.doc-only) }}
Copy link
Member

@leofang leofang Jan 14, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Q: If it's doc-only, we don't need to run tests, so I think this change can be dropped. We currently do not run doctest anyway (we probably should, but it is not easy to set up).

My main concern is that we ignore the warnings across this file that require jobs to be kept in sync. (We manually split them and violated DRY so as to gain parallelism in the CI.)

permissions:
contents: read # This is required for actions/checkout
needs:
- ci-vars
- should-skip
- build-linux-64
secrets: inherit
uses: ./.github/workflows/test-wheel-linux.yml
Expand All @@ -142,6 +149,8 @@ jobs:
host-platform:
- linux-aarch64
name: Test ${{ matrix.host-platform }}
# Note: No doc-only check needed here - if build-linux-aarch64 is skipped,
# this job is automatically skipped due to the dependency.
if: ${{ github.repository_owner == 'nvidia' }}
permissions:
contents: read # This is required for actions/checkout
Expand All @@ -162,6 +171,8 @@ jobs:
host-platform:
- win-64
name: Test ${{ matrix.host-platform }}
# Note: No doc-only check needed here - if build-windows is skipped,
# this job is automatically skipped due to the dependency.
if: ${{ github.repository_owner == 'nvidia' }}
permissions:
contents: read # This is required for actions/checkout
Expand Down Expand Up @@ -196,6 +207,7 @@ jobs:
if: always()
runs-on: ubuntu-latest
needs:
- should-skip
- test-linux-64
- test-linux-aarch64
- test-windows
Expand All @@ -219,11 +231,18 @@ jobs:
# failing job(s) will timeout causing a cancellation here and the
# build to succeed which we don't want (originally this was just
# 'exit 0')
if ${{ needs.test-linux-64.result == 'cancelled' ||
needs.test-linux-aarch64.result == 'cancelled' ||
needs.test-windows.result == 'cancelled' ||
needs.doc.result == 'cancelled' }}; then
#
# Note: When [doc-only] is in PR title, test jobs are intentionally
# skipped and should not cause failure.
doc_only=${{ needs.should-skip.outputs.doc-only }}
if ${{ needs.doc.result == 'cancelled' }}; then
exit 1
else
exit 0
fi
Comment on lines +238 to 240
Copy link
Member

@leofang leofang Jan 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: can we move this to as an else block below?

if [[ "${doc_only}" != "true" ]]; then
if ${{ needs.test-linux-64.result == 'cancelled' ||
needs.test-linux-aarch64.result == 'cancelled' ||
needs.test-windows.result == 'cancelled' }}; then
exit 1
fi
fi
exit 0
Loading