ci: add lychee broken link validation CI for docs - #6789
Conversation
Signed-off-by: Vanshika <pahalvanshikaa@gmail.com>
e4c2423 to
c870c98
Compare
Ayushmore1214
left a comment
There was a problem hiding this comment.
@vanshika2720 there is already a assignee on this specific idea and a PR has been already raised by @zyzzmohit #6570 no worries at all this is your first time here, mistake often happens, lets do one thing you can join tomorrow's community meet along with @zyzzmohit we can discuss which option works better, see you in the meet tomorrow :)
|
@Ayushmore1214 Yeah, I saw that one, but it looked stale so I opened this instead. |
|
Hi @vanshika2720 thanks for putting this together your approach with the PR diff scanning looks really interesting I've been actively working on #6570 for this issue, but I understand why it might have seemed inactive if there haven't been recent commits |
You might have asked the owner of the PR if the PR is still active or not, but no worries keep in mind from next time |
Hi @zyzzmohit FYI the meet was today not tomorrow, no worries you can discuss the intent here |
|
This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days. |
|
@rahulshendre @mohammedfirdouss PTAL!! |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #6789 +/- ##
==========================================
- Coverage 29.35% 25.92% -3.43%
==========================================
Files 601 468 -133
Lines 64317 51726 -12591
==========================================
- Hits 18880 13410 -5470
+ Misses 43968 37217 -6751
+ Partials 1469 1099 -370 Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
What this PR does:
Introduces an automated broken link and asset checker CI pipeline for the
docs/directory using Lychee..github/workflows/docs-link-checker.yaml):git diffcompared toorigin/masterto isolate and scan only modified markdown files. This guarantees developers are not blocked by legacy, historical broken links.master, it executes a full-health check across all active documentation pages (docs/content/**/*.mdanddocs/README.md).lychee.toml):root_dir = "docs/static"to resolve root-relative paths like/images/...to physical local files.400,403,429) as acceptable.Why we need it:
Manually catching 404 links and broken image assets in documentation is highly error-prone. This CI pipeline:
Does this PR introduce a user-facing change?:
No