Skip to content
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

Link checking in CI #3425

Open
swiatekm opened this issue Nov 6, 2024 · 0 comments
Open

Link checking in CI #3425

swiatekm opened this issue Nov 6, 2024 · 0 comments

Comments

@swiatekm
Copy link
Contributor

swiatekm commented Nov 6, 2024

Describe the issue you're reporting

When and how should we check links in the CI? Our current check is completely nonfunctional, so I'm disabling it in #3424. I tried to fix it, but couldn't get markdown-link-check to not report a bunch of false positives.

Roughly what we should aim for in my opinion:

  • Broken links introduced in a PR should be caught by the CI run for that PR
  • Broken links in the changelog should be caught by the release PR CI
  • We should periodically check all the links in all of our markdown documents (how often? where do we report failures?)

There's also the question of what tool to use here. markdown-link-check seems to produce a lot of false positives, so maybe we should try https://github.com/UmbrellaDocs/linkspector instead?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant