Skip to content

ci(links): include .md files in the weekly link check - #1707

Closed
rnaidu-seqera wants to merge 1 commit into
masterfrom
ci/link-check-include-md
Closed

ci(links): include .md files in the weekly link check#1707
rnaidu-seqera wants to merge 1 commit into
masterfrom
ci/link-check-include-md

Conversation

@rnaidu-seqera

Copy link
Copy Markdown
Contributor

Problem

The weekly Links workflow passes lychee a single glob:

args: --base . -v -n -s https -s http './**/*.mdx'

So only .mdx files are checked. This repo has 1,896 .md files 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-charts links on enterprise/platform-helm.md were 404ing across five doc versions, and a customer found it before CI did, because platform-helm.md is a .md file. (Link fix: #1705.)

Change

  • Add './**/*.md' to the lychee globs.
  • Extend the existing "Remove TODO and README files" cleanup step to also drop README.md and _todo.md from versioned docs — it already did this for the .mdx variants, and there are 9 such .md files 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 exclude list in lychee.toml is the place to triage bot-blocking 403s.

YAML validated locally.

🤖 Generated with Claude Code

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>
@netlify

netlify Bot commented Aug 3, 2026

Copy link
Copy Markdown

Deploy Preview for seqera-docs ready!

Name Link
🔨 Latest commit e53e5e8
🔍 Latest deploy log https://app.netlify.com/projects/seqera-docs/deploys/6a70ca301ebdac00087e136b
😎 Deploy Preview https://deploy-preview-1707--seqera-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@rnaidu-seqera

Copy link
Copy Markdown
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.

@rnaidu-seqera
rnaidu-seqera deleted the ci/link-check-include-md branch August 3, 2026 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant