Skip to content

Exclude OLCF Summit URL from link checker#1279

Merged
sbryngelson merged 1 commit intoMFlowCode:masterfrom
sbryngelson:docs
Mar 1, 2026
Merged

Exclude OLCF Summit URL from link checker#1279
sbryngelson merged 1 commit intoMFlowCode:masterfrom
sbryngelson:docs

Conversation

@sbryngelson
Copy link
Copy Markdown
Member

Summary

  • Exclude https://www.olcf.ornl.gov/summit from Lychee link checks

The OLCF site returns 503 to automated requests and sends a 1-hour rate limit backoff, causing the docs CI to fail.

Test plan

  • Docs CI passes with this change

The OLCF site returns 503 to automated requests and sends a 1-hour
rate limit backoff, causing the Lychee link check to fail.
@sbryngelson sbryngelson marked this pull request as ready for review March 1, 2026 05:14
Copilot AI review requested due to automatic review settings March 1, 2026 05:14
@qodo-code-review
Copy link
Copy Markdown
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Regex Match

Confirm the excluded pattern matches all link variants encountered in the docs (e.g., trailing slash, http->https redirects, or additional path/query components) so the CI failure is fully mitigated without needing repeated excludes.

exclude = [
    "https://mflowcode\\.github\\.io/sitemap\\.xml",  # Only exists after deployment
    "https://cpe\\.ext\\.hpe\\.com",                   # HPE Cray docs have broken SSL cert
    "https://sc22\\.supercomputing\\.org",              # Returns 415 to automated requests
    "https://strawberryperl\\.com",                    # Frequently times out
    "https://www\\.olcf\\.ornl\\.gov/summit",            # Returns 503 to automated requests
]

@sbryngelson sbryngelson merged commit 021322c into MFlowCode:master Mar 1, 2026
24 of 26 checks passed
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 1, 2026

Claude Code Review

Head SHA: 7687635

Files changed: 1

  • .lychee.toml

Summary

  • Single-line addition to the Lychee link checker exclusion list in .lychee.toml
  • Excludes https://www.olcf.ornl.gov/summit from automated link checks
  • Rationale is well-documented in both the diff comment and the PR body (503 + 1-hour rate limit backoff)
  • Consistent with the existing pattern for other excluded URLs in the file

Findings

No issues found.

Improvement Opportunities

  1. URL pattern scope: The excluded pattern https://www\.olcf\.ornl\.gov/summit will only match that exact path prefix. If other OLCF pages (e.g., /olcf-for-users/) also return 503, they would still cause failures. Consider whether a broader https://www\.olcf\.ornl\.gov exclusion is appropriate, though the narrower scope is the safer default.

This is a minimal, well-reasoned CI maintenance change with no correctness concerns.

"https://cpe\\.ext\\.hpe\\.com", # HPE Cray docs have broken SSL cert
"https://sc22\\.supercomputing\\.org", # Returns 415 to automated requests
"https://strawberryperl\\.com", # Frequently times out
"https://www\\.olcf\\.ornl\\.gov/summit", # Returns 503 to automated requests
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggestion: Anchor the regular expression for the excluded URL with ^ to prevent it from matching substrings within other URLs. [possible issue, importance: 4]

Suggested change
"https://www\\.olcf\\.ornl\\.gov/summit", # Returns 503 to automated requests
"^https://www\\.olcf\\.ornl\\.gov/summit", # Returns 503 to automated requests

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 1, 2026

Claude Code Review

Head SHA: 7687635

Files changed: 1

  • .lychee.toml

Summary

  • Single-line addition to the Lychee link-checker exclusion list
  • Excludes https://www.olcf.ornl.gov/summit due to HTTP 503 responses that cause docs CI failures
  • Follows the exact same pattern and comment style as existing exclusions
  • No functional code changes; docs/CI-only impact

Findings

No issues found.

Improvement Opportunities (optional)

  • The exclusion regex https://www\.olcf\.ornl\.gov/summit only covers the /summit path. If other OLCF pages also return 503 to automated requests in the future, you may want to broaden to https://www\.olcf\.ornl\.gov — but this is speculative and the current narrow scope is the safer default.

Verdict: LGTM. The change is minimal, correctly motivated, and consistent with the existing exclusion list conventions.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the repository’s Lychee link-checker configuration to avoid CI failures caused by the OLCF Summit webpage returning 503/rate-limiting automated requests.

Changes:

  • Added https://www.olcf.ornl.gov/summit to Lychee’s exclude URL patterns to prevent link-check retries/backoff from failing docs CI.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 1, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b5486c9 and 7687635.

📒 Files selected for processing (1)
  • .lychee.toml

📝 Walkthrough

Walkthrough

The pull request modifies the .lychee.toml configuration file to add a new URL to the excluded external failures list. Specifically, "https://www.olcf.ornl.gov/summit" is added to the exclude section, which will prevent link checking from validating this URL. The change consists of a single line addition with no modifications to other configuration parameters such as retries, timeouts, or accepted status codes.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

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

Development

Successfully merging this pull request may close these issues.

2 participants