ci: Check for broken links in MD files #494
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This PR adds a CI workflow that checks for broken links in MD files. The workflow is currently configured to run on each PR as well as manually (mostly to be able to test it once merged).
Upstream CAPI workflows use a 3rd party action to achieve the same, which we could use but it will require approval by RST to be able to run it in this repo. And since this action is no longer supported, I thought it would be best to invoke the tool that the 3rd party action is using under the hood.
Which issue(s) this PR fixes:
Fixes #493
Special notes for your reviewer:
You can view results from previous CI runs in https://github.com/rancher/cluster-api-provider-rke2/actions/workflows/pr-md-link-check.yml
Checklist: