Skip to content

Restore markdown link checking#5445

Draft
nightt5879 wants to merge 1 commit into
OAI:mainfrom
nightt5879:fix/5414-markdown-link-checking
Draft

Restore markdown link checking#5445
nightt5879 wants to merge 1 commit into
OAI:mainfrom
nightt5879:fix/5414-markdown-link-checking

Conversation

@nightt5879

Copy link
Copy Markdown

close #5414

Changes:

Rationale:
The previous file mode checked the entire modified file, which meant pre-existing broken links or temporary failures on external websites could block otherwise unrelated PRs. Using added limits the check to broken links introduced by newly added lines.

Impact:

  • Restores Markdown link validation in CI.
  • Reduces false positives and prevents unrelated PRs from being blocked by existing link issues.

Validation:

  • actionlint passed.
  • npm run validate-markdown passed.
  • npm test passed: 8/8.
  • git diff --check passed.

Schema:
No schema changes are required.

AI disclosure:
Codex was used to analyze historical CI logs, update the workflow, and run validation checks. I personally reviewed and confirmed the changes.

  • no schema changes are needed for this pull request

Re-enable Linkspector for newly added lines so broken links are caught without blocking unrelated pull requests on pre-existing or transient failures.

Refs OAI#5414
@nightt5879
nightt5879 requested review from a team as code owners July 24, 2026 09:24
@lornajane

Copy link
Copy Markdown
Contributor

Thanks @nightt5879 , just a few comments immediately:

  • we do need to check the whole file, not just the added lines, in case of link decay on our specification documents. This was an intentional design choice.
  • I'm also switching the status on this to draft, there's work going on in the wider build system that needs to land first (see [DRAFT] Migrate to new shared build infrastructure. #5424) and we may ask for more updates once that is complete.

@lornajane
lornajane marked this pull request as draft July 24, 2026 09:44
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.

Add link checking for markdown documents

2 participants