ci(docs): add automated documentation link validation workflow and script (#720) - #725
Open
ravendevhub wants to merge 1 commit into
Open
ci(docs): add automated documentation link validation workflow and script (#720)#725ravendevhub wants to merge 1 commit into
ravendevhub wants to merge 1 commit into
Conversation
…ript (Core-Foundry#720) - Add Python markdown link parser checking relative internal file paths - Safely exclude external http/https/mailto URLs to prevent flaky CI failures - Create GitHub Actions workflow triggered on Markdown PR changes - Support --warn-only and strict verification modes - Document link validation policy in docs/DOC_LINK_VALIDATION.md
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
1 participant
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.
Summary
Resolves #720 by introducing an automated markdown link validator script (
scripts/check-doc-links.py) and a dedicated GitHub Actions CI workflow (.github/workflows/doc-link-validation.yml) to continuously catch broken internal repository documentation links without failing on external network fluctuations.Changes
scripts/check-doc-links.py):http://,https://,mailto:) URLs by design to keep CI fast and non-flaky.--warn-onlyand strict enforcement modes..github/workflows/doc-link-validation.yml):docs/DOC_LINK_VALIDATION.md):Acceptance Criteria