Skip to content

build: require symlinks on Windows; move lychee excludes to lychee.toml - #2992

Merged
juenglin merged 2 commits into
NVIDIA:mainfrom
juenglin:miscellaneous
Oct 1, 2026
Merged

juenglin merged 2 commits into
NVIDIA:mainfrom
juenglin:miscellaneous

Conversation

@juenglin

@juenglin juenglin commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Broken out of #2965 so that the small, independent pieces can land first and keep that PR focused on the build-hook consolidation. Nothing here changes how any package is built.

Changes

  • Windows runners enable git symlinks before checkout. build-wheel.yml, test-wheel-windows.yml and test-sdist-windows.yml gain a git config --global core.symlinks true step ahead of actions/checkout. This is a no-op today, but build: consolidate toolchain helpers via symlink #2965 shares _build_shared.py between cuda_bindings and cuda_core via a symlink, which would otherwise be checked out as a plain text stub on Windows.
  • New "Development on Windows" section in CONTRIBUTING.md. It documents Developer Mode, git config --global core.symlinks true, and how to recover an existing clone. The former "Pre-commit on Windows" subsection moves into it as "Pre-commit lychee workaround", leaving a pointer behind. A short note is also added at the top of "Cloning the repository".
  • Link-checker excludes move to lychee.toml. The three excludes previously inlined in build-docs.yml (PR-preview URLs, cuda-bindings #id anchors, preferred.jp) and their comments move into a repo-root lychee.toml. The workflow now passes --config ${{ github.workspace }}/lychee.toml. Behavior is unchanged.

Notes for reviewers

Move the link-checker excludes out of build-docs.yml into a repo-root
lychee.toml, and point the workflow at it with --config. This keeps the
exclude list and its explanatory comments in one place. No behavior change.
Set core.symlinks=true before checkout in the Windows wheel, wheel-test
and sdist-test workflows, and add a "Development on Windows" section to
CONTRIBUTING.md covering symlink setup (Developer Mode, core.symlinks).
The existing pre-commit lychee workaround moves into that section.
@copy-pr-bot

copy-pr-bot Bot commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

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.

@github-actions github-actions Bot added the CI/CD CI/CD infrastructure label Oct 1, 2026
@juenglin juenglin self-assigned this Oct 1, 2026
@juenglin juenglin added the cuda.bindings Everything related to the cuda.bindings module label Oct 1, 2026
@juenglin juenglin added this to the cuda.core 1.3.0 milestone Oct 1, 2026
@juenglin juenglin changed the title build: require symlinks on Windows build: require symlinks on Windows; move lycee excludes to lychee.toml Oct 1, 2026
@juenglin
juenglin requested a review from Andy-Jost October 1, 2026 21:50
@juenglin

juenglin commented Oct 1, 2026

Copy link
Copy Markdown
Contributor Author

/ok to test 0ec438c

@juenglin
juenglin marked this pull request as ready for review October 1, 2026 21:51
@juenglin juenglin changed the title build: require symlinks on Windows; move lycee excludes to lychee.toml build: require symlinks on Windows; move lychee excludes to lychee.toml Oct 1, 2026
@github-actions

github-actions Bot commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor
Doc Preview CI
Preview removed because the pull request was closed or merged.

@juenglin
juenglin merged commit 6d6af42 into NVIDIA:main Oct 1, 2026
125 checks passed
github-actions Bot pushed a commit that referenced this pull request Oct 2, 2026
Removed preview folders for the following PRs:
- PR #2920
- PR #2957
- PR #2973
- PR #2982
- PR #2983
- PR #2990
- PR #2991
- PR #2992
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI/CD CI/CD infrastructure cuda.bindings Everything related to the cuda.bindings module

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants