Skip to content

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

Merged
merged 2 commits into from
Apr 30, 2025

Conversation

alexander-demicev
Copy link
Member

@alexander-demicev alexander-demicev commented Apr 29, 2025

This PR adds a simple script to verify that all URLs are valid and fixes all currently broken urls

@alexander-demicev alexander-demicev requested a review from a team as a code owner April 29, 2025 15:04
@alexander-demicev alexander-demicev force-pushed the brokenlinks branch 2 times, most recently from 2d70d2f to 3afd578 Compare April 29, 2025 20:10
Signed-off-by: Alexandr Demicev <[email protected]>
@alexander-demicev alexander-demicev changed the title WIP Add workflow to check for broken links Add workflow to check for broken links Apr 30, 2025
@alexander-demicev alexander-demicev changed the title Add workflow to check for broken links Add workflow to check for broken urls Apr 30, 2025
@alexander-demicev alexander-demicev moved this to Proposals In Progress (3 max) in CAPI / Turtles Apr 30, 2025
@alexander-demicev alexander-demicev moved this from Proposals In Progress (3 max) to PR to be reviewed in CAPI / Turtles Apr 30, 2025
Copy link
Contributor

@mjura mjura left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@yiannistri yiannistri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice one 👍

Copy link
Contributor

@furkatgofurov7 furkatgofurov7 left a 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

@Danil-Grigorev
Copy link
Contributor

It is also relevant in a nightly CI, as we may not always notice changes in documentation, if no PRs were open.

@alexander-demicev
Copy link
Member Author

I will make it run on push to main in a follow-up pr

@alexander-demicev alexander-demicev merged commit ae4c036 into rancher:main Apr 30, 2025
4 checks passed
@github-project-automation github-project-automation bot moved this from PR to be reviewed to Done in CAPI / Turtles Apr 30, 2025
@alexander-demicev alexander-demicev deleted the brokenlinks branch April 30, 2025 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

6 participants