Skip to content

feat: add markdown link validation to CI#68

Merged
PAMulligan merged 2 commits intomainfrom
5-add-markdown-link-validation-to-ci
Apr 9, 2026
Merged

feat: add markdown link validation to CI#68
PAMulligan merged 2 commits intomainfrom
5-add-markdown-link-validation-to-ci

Conversation

@PAMulligan
Copy link
Copy Markdown
Contributor

Summary

  • Adds a check-links CI job using lychee to validate internal and external links in markdown files
  • Checks all .md files in the repo root and docs/ directory
  • Includes .lychee.toml config with retry/timeout settings, concurrency limits, and exclusions for URLs that block automated checks (Patreon, shield badges)
  • Runs in parallel with the existing validate job

Test plan

  • CI check-links job passes on this branch
  • Verify lychee correctly identifies broken links by temporarily adding one
  • Confirm .claude/ directory is excluded from checks
  • Confirm code blocks with example links are not flagged

Closes #5

🤖 Generated with Claude Code

Add lychee-based link checking as a parallel CI job to catch broken
internal and external links in documentation files. Includes a
.lychee.toml config with retry/timeout settings and exclusions for
URLs known to block automated checks.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@PAMulligan PAMulligan linked an issue Apr 9, 2026 that may be closed by this pull request
6 tasks
The lychee-action was not automatically picking up .lychee.toml,
causing Patreon URLs (which return 403 to automated checks) to
fail the build.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@PAMulligan PAMulligan self-assigned this Apr 9, 2026
@PAMulligan PAMulligan added area: ci-cd CI/CD workflows area: security Security features area: deployment Deployment targets area: docs Documentation labels Apr 9, 2026
@PAMulligan PAMulligan moved this from Todo to Done in PMDS Open Source Roadmap Apr 9, 2026
Copy link
Copy Markdown
Contributor Author

@PAMulligan PAMulligan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@PAMulligan PAMulligan merged commit bc2c86f into main Apr 9, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: ci-cd CI/CD workflows area: deployment Deployment targets area: docs Documentation area: security Security features

Projects

Development

Successfully merging this pull request may close these issues.

Add markdown link validation to CI

1 participant