make removed URL check aware of docs/redirects.txt#612
Open
rajannpatel wants to merge 2 commits into
Open
Conversation
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
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.
Description
This PR updates the
check-removed-urls.ymlGitHub workflow to prevent false positives when a documentation page is intentionally removed or renamed, but a proper redirect has already been configured indocs/redirects.txt.Previously, the workflow performed a strict text diff on the built HTML output. If a URL disappeared, the check failed immediately, completely unaware that a redirect existed.
Key Changes
workflow_callInputs: decoupled the base reference variables so this workflow can be cleanly reused by other pipelines.findandsedpipeline to parse built HTML structures safely and output clean, predictable path formats.docs/redirects.txtusing the nativecsvmodule and checks all structural markdown possibilities (page.md,page/index.md, or directory-level paths) before flagging a URL as missing.Testing Instructions
docs/redirects.txt, the workflow should fail and list the unhandled URL.docs/redirects.txt, the workflow should print a green checkmark (✅ Ignored) and pass successfully.Checklist
redirects.txtCHANGELOG.mdwith relevant non-documentation file changes?