feat: migrate from markdown-link-check to lychee#5519
Merged
Conversation
Migrates all link checking from markdown-link-check to lychee to solve transient network failures in CI. markdown-link-check only retries HTTP 429 (rate-limiting) errors, while lychee retries all network errors (timeouts, DNS failures, connection errors). Fixes PRQL#5511 - gohugo.io link check failures due to network errors Changes: - Replace markdown-link-check GitHub Action with lychee via pre-commit - Use whitelist approach (--include) for PR checks: only PRQL domains + local files - Single config file (.config/lychee.toml) for nightly/comprehensive checks - Auto-install lychee via pre-commit's language: rust feature - Add lychee cache in CI for faster runs - Delete old markdown-link-check config files Benefits: - Solves transient network failures with comprehensive retry logic - Faster link checking (Rust-based vs Node.js) - Built-in caching reduces external site load - Cleaner configuration with whitelist pattern 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
pre-commit.ci doesn't support network access and lacks OpenSSL dev headers needed to compile lychee. Skip both lychee hooks in CI config. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Migrates all link checking from
markdown-link-checktolycheeto solve transient network failures in CI.Fixes #5511 - The nightly CI failure where
gohugo.iowas unreachable due to network errors.markdown-link-checkonly retries HTTP 429 (rate-limiting) errors, whilelycheeretries all network errors (timeouts, DNS failures, connection errors).Changes
CI Workflow (
.github/workflows/tests.yaml)markdown-link-checkGitHub Action withlycheevia pre-commitbaptiste0928/cargo-install@v3for installation (existing CI pattern).lycheecacheto speed up runsPre-commit Hooks (
.pre-commit-config.yaml)lychee(PR/local) andlychee-all(nightly/manual)language: rustwithadditional_dependencies: ["cli:lychee:0.20.1"]for auto-installation--includepattern checks only PRQL domains + local files for PRsgithub.com/PRQL/*andgithub.com/prql/*prql-lang.org/*raw.githubusercontent.com/PRQL/*andraw.githubusercontent.com/prql/*file://(local/relative links)Configuration (
.config/lychee.toml)Cleanup
.config/.markdown-link-check-all.json.config/.markdown-link-check-local.json.lycheecacheto.gitignoreBenefits
Test Plan
lychee-allhook🤖 Generated with Claude Code