Skip to content

Add scheduled Lychee link check - #206

Open
chyunsu3 wants to merge 2 commits into
rapidsai:mainfrom
chyunsu3:adopt_lychee
Open

Add scheduled Lychee link check#206
chyunsu3 wants to merge 2 commits into
rapidsai:mainfrom
chyunsu3:adopt_lychee

Conversation

@chyunsu3

@chyunsu3 chyunsu3 commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Adds a cached Lychee workflow that checks Markdown, HTML, and reStructuredText links every Monday, Wednesday, and Friday. Pull request CI starts failing after 14 days without a successful link check.

Modeled after rapidsai/rmm#2532

Example run: https://github.com/chyunsu3/nvforest/actions/runs/33471974909/job/99743405587

@copy-pr-bot

copy-pr-bot Bot commented Sep 1, 2026

Copy link
Copy Markdown

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.

@chyunsu3
chyunsu3 marked this pull request as ready for review September 1, 2026 04:47
@chyunsu3
chyunsu3 requested review from a team as code owners September 1, 2026 04:47
@chyunsu3
chyunsu3 requested a review from bdice September 1, 2026 04:47
@chyunsu3 chyunsu3 added improvement Improves an existing functionality non-breaking Introduces a non-breaking change labels Sep 1, 2026
@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 38991552-e067-4938-ba48-ef2b17ad940d

📥 Commits

Reviewing files that changed from the base of the PR and between 4c81752 and 10870e4.

📒 Files selected for processing (1)
  • .github/workflows/pr.yaml

Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review.


📝 Walkthrough

Summary by CodeRabbit

  • Chores

    • Added scheduled and manual automated link checking for Markdown, HTML, and reStructuredText files.
    • Configured link-checking retries, caching, concurrency, timeouts, and exclusions for known non-actionable links.
    • Added validation to ensure link checks have recently passed before nightly CI proceeds.
  • Documentation

    • Updated the README contact link to point to CUDA-X for Data Science.

Walkthrough

Adds scheduled and manual Lychee link checks for tracked documentation files. Configures retries, caching, concurrency, exclusions, and recent PR validation. Updates the README Contact link to CUDA-X for Data Science.

Changes

Lychee link checking

Layer / File(s) Summary
Scheduled Lychee validation
.github/workflows/link-checks.yaml, .lychee.toml, .github/workflows/pr.yaml
Adds scheduled and manual checks with restricted permissions, file discovery, Lychee execution, failure handling, cache management, retries, exclusions, and target-branch validation.

README contact link

Layer / File(s) Summary
Contact destination update
README.md
Replaces the RAPIDS community link with the CUDA-X for Data Science link.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 10870

The PR adds scheduled cached link checking and updates a documentation link; no actionable merge-blocking risk remains, so it is merge-ready after normal checks and review.

Suggested reviewers: bdice, jameslamb, jolorunyomi

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly summarizes the main change: adding a scheduled Lychee link-check workflow.
Description check ✅ Passed The description accurately explains the cached Lychee workflow schedule and the 14-day pull request CI requirement.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement Improves an existing functionality non-breaking Introduces a non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants