MOD-11173: Fix unreachable links in markdown files#6773
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #6773 +/- ##
==========================================
- Coverage 87.29% 86.30% -0.99%
==========================================
Files 287 288 +1
Lines 45427 46513 +1086
Branches 8375 9404 +1029
==========================================
+ Hits 39654 40143 +489
- Misses 5646 6219 +573
- Partials 127 151 +24
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
🔗 Link Check FailedSome links in the modified Markdown files are broken or unreachable. Please check the workflow logs for details and fix the broken links. You can run the link checker locally with: python scripts/check_links.py .Note: This check validates both URL accessibility and anchor existence. |
There was a problem hiding this comment.
Pull Request Overview
This PR implements a comprehensive link checker for Markdown files to detect and report broken or unreachable links, addressing ticket MOD-11173. The solution includes both the tooling infrastructure and fixes for existing broken links in the documentation.
- Adds a complete link checking system with Python scripts, configuration, and CI/CD integration
- Fixes broken links in README.md by updating outdated Redis documentation URLs and correcting the logo image path
- Integrates link checking into the build system with new Makefile targets and GitHub Actions workflows
Reviewed Changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/check_links.py | Main link checker implementation with HTTP validation, anchor verification, and relative path checking |
| scripts/link-check-config.json | Configuration file defining exclusion patterns, timeouts, and checker behavior |
| scripts/requirements-linkcheck.txt | Python dependencies for the link checker (requests, beautifulsoup4, lxml) |
| scripts/test_link_checker.py | Test suite creating sample markdown files to validate link checker functionality |
| scripts/README-linkcheck.md | Comprehensive documentation for the link checker tool and its usage |
| README.md | Fixed broken links by updating Redis documentation URLs and correcting logo image path |
| Makefile | Added link checking targets (check-links, check-links-verbose, test-linkcheck) |
| .github/workflows/link-check.yml | GitHub Action for link checking on PRs with markdown file changes |
| .github/workflows/event-weekly.yml | Added weekly automated link checking job |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
🔗 Link Check FailedSome links in the modified Markdown files are broken or unreachable. Please check the workflow logs for details and fix the broken links. You can run the link checker locally with: python scripts/check_links.py .Note: This check validates both URL accessibility and anchor existence. |
2 similar comments
🔗 Link Check FailedSome links in the modified Markdown files are broken or unreachable. Please check the workflow logs for details and fix the broken links. You can run the link checker locally with: python scripts/check_links.py .Note: This check validates both URL accessibility and anchor existence. |
🔗 Link Check FailedSome links in the modified Markdown files are broken or unreachable. Please check the workflow logs for details and fix the broken links. You can run the link checker locally with: python scripts/check_links.py .Note: This check validates both URL accessibility and anchor existence. |
oshadmi
force-pushed
the
oshadmi_fix_docs_urls
branch
from
976442a to
3e1f0da
Compare
* MOD-11173: Fix unreachable links in markdown files * Add link-check script and workflow for markdown files * Use action upload-artifact@v4 * Use system-wide uv install * Fix copilot review + add debug for missing file * Fix failed local url, remove debug code * Trigger link-check using a label "check-links" * Fix URL encoding in README.md which fail on CI * Code review fixes
Describe the changes in the pull request
Fix unreachable links in markdown files and add a
make check-linksscan to report bad links(consider also Rust source files? Which may also include documentation snippets and contains URLs)
A clear and concise description of what the PR is solving, including:
Which additional issues this PR fixes
Main objects this PR modified
Mark if applicable