ci(links): include .md files in the weekly link check - #1707
Closed
rnaidu-seqera wants to merge 1 commit into
Closed
ci(links): include .md files in the weekly link check#1707rnaidu-seqera wants to merge 1 commit into
rnaidu-seqera wants to merge 1 commit into
Conversation
The lychee glob only matched './**/*.mdx', so the 1,896 .md files in the repo were never link-checked. That is how four broken helm-charts links on platform-helm.md (a .md file) reached a customer report (FD-7794). Also extends the pre-check cleanup step to drop README.md and _todo.md from versioned docs, matching what it already did for the .mdx variants. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
✅ Deploy Preview for seqera-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Author
|
Closing at the author's request to keep the queue clear while #1706 (EDU-1330) handles the reported links from FD-7794. Note for anyone who finds this later: the gap described here is still present on master. The weekly Links workflow globs './**/*.mdx' only, so the repo's ~1,896 .md files are never link-checked — which is why the broken links in #1706 reached a customer report rather than the Sunday job. Reopen or re-do if someone wants to pick it up. |
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
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.
Problem
The weekly
Linksworkflow passes lychee a single glob:So only
.mdxfiles are checked. This repo has 1,896.mdfiles against 351.mdx— meaning the large majority of documentation pages have never had their external links validated.That's how FD-7794 happened: all four
helm-chartslinks onenterprise/platform-helm.mdwere 404ing across five doc versions, and a customer found it before CI did, becauseplatform-helm.mdis a.mdfile. (Link fix: #1705.)Change
'./**/*.md'to the lychee globs.README.mdand_todo.mdfrom versioned docs — it already did this for the.mdxvariants, and there are 9 such.mdfiles that should get the same treatment.Heads-up for reviewers
The first run after merge will check ~6× more files than before and will very likely file a sizeable Link Checker Report issue, since none of these links have ever been validated. That backlog is pre-existing rot being surfaced, not something this PR introduces — but it's worth expecting so it isn't mistaken for a regression. If the volume is unwieldy, the
excludelist inlychee.tomlis the place to triage bot-blocking 403s.YAML validated locally.
🤖 Generated with Claude Code