-
Notifications
You must be signed in to change notification settings - Fork 18
Add workflow to check for broken urls #293
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 workflow to check for broken urls #293
Conversation
2d70d2f
to
3afd578
Compare
Signed-off-by: Alexandr Demicev <[email protected]>
Signed-off-by: Alexandr Demicev <[email protected]>
3afd578
to
cfdf079
Compare
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.
LGTM
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.
Nice one 👍
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.
This is great, but we could also introduce GHA as CI requirement to check links in PRs directly to avoid such issues in future if someone forgets to run local Makefile target for example: https://github.com/kubernetes-sigs/cluster-api/blob/main/.github/workflows/pr-md-link-check.yaml from CAPI could be good example
It is also relevant in a nightly CI, as we may not always notice changes in documentation, if no PRs were open. |
I will make it run on push to main in a follow-up pr |
This PR adds a simple script to verify that all URLs are valid and fixes all currently broken urls