imporved the check-broken-link-md.py script according to the description #224
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 addresses and resolves #222 by improving the check-broken-links-md.py script to make it more robust, maintainable, and reliable.
Changes Made:
✅ Fixed whitelist handling so only non-exempt URLs are flagged.
✅ Improved subprocess handling to separate stdout/stderr for clearer debugging.
✅ Replaced os._exit(1) with sys.exit(1) for safe process termination.
✅ Introduced regex-based parsing instead of fragile string checks.
✅ Refactored code into smaller, testable functions.
✅ Centralized constants (e.g., 429 status code, exception list).
✅ Added support for configurable exception lists (via CLI or JSON/YAML).
✅ Enhanced output with clearer summary of links checked, failed, and skipped.
Why this is needed:
These changes make the script easier to maintain, extend, and debug, while ensuring accurate link checking results and safer process handling.
Screenshots