-
Notifications
You must be signed in to change notification settings - Fork 412
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 function to check python readme links are valid and absolute #739
base: main
Are you sure you want to change the base?
Conversation
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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.
Please do pass with ruff
on this script (see https://github.com/google/magika/actions/runs/11150217299/job/31080639258?pr=739)
I suggest to setup ruff to be run "on save" in your IDE (eg vscode).
Thanks for the PR! Did a first review. Let me know if you have questions. |
Hello @brokoli777, still interested in helping out on this or should I take from here? |
Oh very sorry! For some reason, I didn't realize there was a reply to the pull request. I will do the recommended changes right now. |
Thanks, new round of comments:
Thanks! |
Hi, I believe I completed the mentioned suggestions. Let me know if it works on your end. |
I added a check for the python README file to check if all the links are valid and not relative.
If the links are not valid, it will print out the invalid links for review and stops the script (stopping the package build in the process).
Currently, this is assuming that all the links in the README file will be pointing to GitHub, if that is not the case, I can modify it to check if it is an HTTPS link.
Closes #730.