Add: Automated dead link checking workflow with lychee-action and ignore list
This PR adds an automated GitHub Actions workflow for dead link checking using lychee-action.
Here’s what’s included and how it works:
- [x] Automated link checking
The new workflow (
.github/workflows/link-check.yml) runs daily and checks all links inREADME.mdfor dead or problematic URLs using lychee.
- [x] Artifact reporting
After each run, a detailed report is generated and uploaded as a downloadable artifact (you’ll find it in the Actions tab for each run). Makes it easier to review which links failed for all maintainers, without committing report files to the repository.
- [x] Ignore list for false positives:
Some sites (such as Reddit, Substack, and others) block automated checkers or bots and show up as “dead” even though they’re working. To avoid these false positives, a
.lycheeignorefile has been added at the repository root. Any URLs listed here will be skipped by lychee. Please update this file whenever new false positives are identified, or when sites become accessible again.
- [x] No manual report management needed:
All reporting is handled via workflow artifacts; there’s no need to manually update or commit any link reports.
How to use and maintain:
- If a legitimate dead link is flagged, remove or fix it in the README as usual.
- If a working link is falsely flagged, add it to
.lycheeignoreso it isn’t reported in future runs. - The workflow can also be triggered manually from the Actions tab if you want to check links after an update.
[!NOTE] This workflow is meant to help keep the list up-to-date and reduce the manual effort of checking links. If you’d like to change the schedule, check other files, or adjust how false positives are handled, feel free to edit the workflow or
.lycheeignore.
@DirectorySurf friendly ping ☺️