Skip to content

ci(root): check links in changed markdown - #1890

Open
sylvesterkaczmarek wants to merge 1 commit into
mi6:developfrom
sylvesterkaczmarek:ci/1593-markdown-link-check
Open

sylvesterkaczmarek wants to merge 1 commit into
mi6:developfrom
sylvesterkaczmarek:ci/1593-markdown-link-check

Conversation

@sylvesterkaczmarek

Copy link
Copy Markdown
Contributor

Summary

Add a Markdown link check to the pull request workflow.

The new job uses Lychee to validate links in Markdown and MDX files changed by a PR.

Why

Broken guidance links can be introduced when pages move or are renamed. Checking only changed documentation catches new regressions without making unrelated PRs fail because of any pre-existing links elsewhere in the site.

Implementation

  • collect added, copied, modified, and renamed .md and .mdx files from the PR diff;
  • skip link checking when no Markdown files changed;
  • run the SHA-pinned Lychee action against those files;
  • fail the PR check when a changed document contains a broken link;
  • publish the Lychee result in the job summary.

Closes #1593

@GCHQ-Developer-530

Copy link
Copy Markdown
Contributor

Please can you rebase this pull request?

@sylvesterkaczmarek
sylvesterkaczmarek force-pushed the ci/1593-markdown-link-check branch from e2f8310 to 5d99614 Compare August 21, 2026 20:19
@sylvesterkaczmarek

Copy link
Copy Markdown
Contributor Author

Rebased onto the latest develop. Thanks!

This branch has not been deployed

No deployments
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.

2 participants