Skip to content

fix(ci): check source references under docs - #1611

Merged
nihalpasham merged 2 commits into
NVIDIA:mainfrom
PavanaSakethaRam:fix/1248-docs-source-references
Nov 3, 2026
Merged

nihalpasham merged 2 commits into
NVIDIA:mainfrom
PavanaSakethaRam:fix/1248-docs-source-references

Conversation

@PavanaSakethaRam

@PavanaSakethaRam PavanaSakethaRam commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

What This PR Does

Adds "docs" to ROOTS in cuda-oxide/scripts/check-source-references.sh so broken prose references to files under the repository's docs/ directory (docs/build_all_docs.sh, docs/conf.py, docs/index.md) are caught by CI instead of silently ignored.

BEFORE:
  ROOTS = ("cuda-oxide/crates", "cuda-oxide/cuda-oxide-book", "cuda-oxide/scripts")
  prose reference to `docs/missing.md` ──► ignored (silent PASS)

AFTER:
  ROOTS = ("cuda-oxide/crates", "cuda-oxide/cuda-oxide-book", "cuda-oxide/scripts", "docs")
  prose reference to `docs/missing.md` ──► rejected by check-source-references.sh
  • Adds 10 embedded self-test controls covering missing docs/ files, untracked docs/ files, Markdown links, Rust doc comments, path traversal (docs/../README.md), external URLs, and declared generated outputs.

Verification

  • bash cuda-oxide/scripts/check-source-references.sh: PASS (96 repository-anchored paths checked, plus all embedded self-test controls).

Closes #1248

Signed-off-by: Chitta Sri Sankara Naga Pavana Saketha Ram <pavan.sakethram@gmail.com>
@copy-pr-bot

copy-pr-bot Bot commented Oct 22, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@PavanaSakethaRam
PavanaSakethaRam marked this pull request as ready for review October 23, 2026 09:00
@nihalpasham nihalpasham added cuda-oxide SIMT programming model: rustc backend, cargo oxide, cuda-device, cuda-host, book bug Something isn't working ci GitHub Actions workflows, runners, and CI configuration labels Oct 29, 2026
@nihalpasham

Copy link
Copy Markdown
Collaborator

Thanks for extending check-source-references.sh to cover the root docs/ tree and adding the self-test controls.

Verified bash cuda-oxide/scripts/check-source-references.sh (96 repo-anchored paths checked) and all repository guards at cc85052e. Merging once CI is green.

Signed-off-by: nihalpasham <nihalp@nvidia.com>
@nihalpasham

Copy link
Copy Markdown
Collaborator

/ok to test 365e79d

@nihalpasham
nihalpasham merged commit f1528a8 into NVIDIA:main Nov 3, 2026
77 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working ci GitHub Actions workflows, runners, and CI configuration cuda-oxide SIMT programming model: rustc backend, cargo oxide, cuda-device, cuda-host, book

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Nothing catches a prose reference to a source file that no longer exists

2 participants