Skip to content

ci: Check for broken links in MD files #494

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
Nov 4, 2024

Conversation

yiannistri
Copy link
Contributor

@yiannistri yiannistri commented Nov 1, 2024

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:

  • squashed commits into logical changes
  • includes documentation
  • adds unit tests
  • adds or updates e2e tests

@yiannistri yiannistri added the area/ci Issues or PRs related to CI label Nov 1, 2024
@yiannistri yiannistri marked this pull request as ready for review November 1, 2024 15:24
@yiannistri yiannistri requested a review from a team as a code owner November 1, 2024 15:24
Copy link
Contributor

@salasberryfin salasberryfin left a comment

Choose a reason for hiding this comment

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

Thanks @yiannistri

@furkatgofurov7 furkatgofurov7 merged commit 3775112 into rancher:main Nov 4, 2024
7 checks passed
@yiannistri yiannistri deleted the 493-ci-check-links branch November 4, 2024 09:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ci Issues or PRs related to CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Check links are valid in CI
3 participants