-
Notifications
You must be signed in to change notification settings - Fork 467
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add broken links checker #3305
Add broken links checker #3305
Conversation
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
✅ No broken markdown links found! |
Love it, if these are all indeed broken! And the internal links are really the ones we care about, so good to scope it to that. |
@@ -0,0 +1,188 @@ | |||
import json |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a small comment while passing by, the Python script needs a license.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also requires formatting.
* Add workflow to check markdown links and comment on PRs * Add PyGithub dependency for GitHub Actions workflow * Fix Python version and update code formatting.- Update Python version to 3.x- Improve code formatting * Update markdown link checker script to use shell script * Add script for checking and commenting on GitHub * Update default directory to "docs/book" in check_and_comment.sh * Update broken links comment creation logic * Ensure proper exit codes for GitHub Actions * Add functionality to check and comment on broken markdown links * fix all links * fix more links * typo fix --------- Co-authored-by: Jayesh Sharma <[email protected]> (cherry picked from commit 5c76c3e)
* Add broken links checker (#3305) * Add workflow to check markdown links and comment on PRs * Add PyGithub dependency for GitHub Actions workflow * Fix Python version and update code formatting.- Update Python version to 3.x- Improve code formatting * Update markdown link checker script to use shell script * Add script for checking and commenting on GitHub * Update default directory to "docs/book" in check_and_comment.sh * Update broken links comment creation logic * Ensure proper exit codes for GitHub Actions * Add functionality to check and comment on broken markdown links * fix all links * fix more links * typo fix --------- Co-authored-by: Jayesh Sharma <[email protected]> (cherry picked from commit 5c76c3e) * Update docker build customization link in code snippet
Describe changes
I added a link checker that runs on every PR
Pre-requisites
Please ensure you have done the following:
develop
and the open PR is targetingdevelop
. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.Types of changes