Skip to content

Conversation

@reidn3r
Copy link
Contributor

@reidn3r reidn3r commented Dec 25, 2025

  • Added lycheeverse as a external link checker.
  • It runs every time that a markdown file is changed.

Here’s why I used these parameters (.github/workflows/links-check.yml):

  1. --accept 200,403
    We accept 403 because sites like Medium, npmjs, and Twitter/X block bots/scrapers and commonly return a 403 even when the link is valid. Since these cases are rare in .md files, accepting 403 avoids false positives without affecting the usefulness of the check.

  2. --max-concurrency 5
    Limiting concurrency is necessary to avoid services like GitHub returning HTTP 429 (Too Many Requests) for pages that are otherwise accessible. Using 5 threads is enough, it prevents hitting rate limits while still keeping the link check reasonably fast.

Checklist

@github-actions github-actions bot added the github actions Github actions related label Dec 25, 2025
@reidn3r reidn3r changed the title [CI]: Add. external link checker ci: Add. external link checker Dec 25, 2025
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 25, 2025
@reidn3r reidn3r mentioned this pull request Dec 25, 2025
@reidn3r
Copy link
Contributor Author

reidn3r commented Dec 27, 2025

Hi! This PR aims to address issue #6385.
@Eomm @jean-michelet could you review it when you have a moment? Thank you!

@reidn3r
Copy link
Contributor Author

reidn3r commented Jan 4, 2026

Copy link
Member

@Eomm Eomm left a comment

Choose a reason for hiding this comment

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

Do you have a link to a test run of this GHA?

@reidn3r
Copy link
Contributor Author

reidn3r commented Jan 17, 2026

Do you have a link to a test run of this GHA?

Not sure if this is exactly what you meant, but it’s already running in this PR. Here’s the link:
https://github.com/fastify/fastify/actions/runs/21097387316/job/60676660184?pr=6424

@Eomm
Copy link
Member

Eomm commented Jan 25, 2026

Ok, I checked the various PRs to solve this task, but I think the #6386 should land:

  • the JustinBeckwith/linkinator-action action is widely used and it has more options (such as redirect check)
  • the action can be run with a quick npx command to test it, so it is much more user friendly than an action that require a PR to run and verify

Thanks for taking care of the task 🙏🏼

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

Labels

documentation Improvements or additions to documentation github actions Github actions related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants