Repository navigation
[no-ci] ci: clarify Lychee cache misses and manual refreshes - #3162
Conversation
Signed-off-by: Ralf W. Grosse-Kunstleve <rgrossekunst@nvidia.com>
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📝 Summary
Priority: ⬇️ Low Change: Feature Merge Risk: ⚪ Minimal · up to
|
There was a problem hiding this comment.
🧹 Nitpick comments: 1
.github/workflows/lychee.yml: 1
5-8: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winsuggestion: Update the workflow comment.
workflow_dispatchwithrefresh-cache=truecan publish both shared baselines. The current “only producer” wording can mislead maintainers about the supported manual refresh procedure. Updating this comment is the complete correction; the workflow logic and README already support the procedure.Suggested fix
# Warm authored and rendered link caches through the configured pre-commit # hooks. Ordinary PRs reuse authored results; full docs CI reuses rendered -# results. Nightly starts afresh, reports unresolved links as warnings, and is -# the only producer of both shared baselines. +# results. Nightly and manual dispatches with refresh-cache=true start afresh, +# report unresolved links as warnings, and can produce both shared baselines.
ℹ️ Review info
⚙️ Run configuration
- Configuration used: Repository: NVIDIA/cuda-python/.coderabbit.yaml
- Review profile: CHILL
- Plan: Enterprise
- Run ID:
32b9d81a-be44-4242-84a7-b48f6d0dfb25
📒 Files selected for processing: 3
.github/actions/lychee-links/action.yml.github/workflows/lychee.ymlci/README.md
Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.
Highlights
lychee.ymlworkflow, with the default branch andrefresh-cachesetting needed to rebuild both baselines.Description
Missing shared caches already fall back to live link checking. The shared action now explains the potential extra runtime and network traffic, and gives maintainers a clear recovery path when the miss is unexpected.
The message also explains the expected cold-cache case: checker changes in a PR can introduce settings that do not yet exist on the default branch. Refreshing the default branch cannot populate a cache for those PR-only settings.
The notice uses
cache-matched-keyto recognize successful prefix restores;cache-hitalone would misidentify them as misses. Deliberate refreshes skip the notice. The workflow link and branch name follow the current repository, covering both authored and rendered checks through the shared action.ci/README.mddocuments the manual refresh procedure and explains that refreshing cached successes does not resolve broken links or upstream rate limits.Rationale for using [no-ci]
The independent Linux and Windows pre-commit checks passed, including cache restoration with the notice correctly suppressed. Missing-cache notice output was validated locally. For these naming, diagnostic, and documentation changes, full package builds, GPU tests, and a documentation build would provide little additional coverage.
Validation
pre-commit run --all-files --show-diff-on-failurepassed, including Lychee and workflow linting.git diff --checkpassed.Checklist
Kept in draft to leave full CI triggering under maintainer control.