-
Notifications
You must be signed in to change notification settings - Fork 182
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
Markdown link check runs on entire repo #332
Comments
What if a file |
In the Java repos, we retry failures (file-by-file) a few times to help mitigate sporadic failures: https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/.github/scripts/markdown-link-check-with-retry.sh |
Definitely not a use case I had considered (repo-internal breakage)....I've only ever seen it break on external outbound links 🤣 . I have no idea how to do this, but if the tools somehow support internal/external distinction this could be useful. Always check/validate internal links but only external links in changed files. I'm sure this is an unreasonable request. 😁 |
Oh, I see that the github action version (not npm) has this How about this compromise (and I'm happy to PR this if that helps):
Thoughts? |
Maybe a simple check to see if the link is a "path" or a "http link" is enough to distinguish? Run checks on "path" links for the entire repo, but only run "http checks" for the modified files? |
That would be easily possible by having two separate markdown-link-check configs, adding one that ignores every link starting with And this would be needed in addition:
|
we are currently getting failures like this which are distracting. MLC has limited control over retry as their setting only work when the server returns things like 429. This means you have to do things like retry externally. We should only start hacking around things like this which are valid to the change IMHO. TL;DR; I totally support constraining the MLC to files changed and/or separating out config in such a way that there is less tripping.
|
As part of #1009 I'm working on converting this repo from MLC to lychee: https://github.com/lycheeverse/lychee/pulls?q=is%3Apr+author%3Atrask will be interesting to see if it helps with this issue or not |
When the required build checks for a PR run, one of these checks is a markdown link checker. This is useful to help ensure that we don't amass a bunch of broken links in the docs. However, the markdown link checker looks like it runs across the entire repo. This can result in PRs failing their checks even when the broken link exists in an unrelated pice of markdown. This can cause small PRs to appear broken even when they are not, and it can extend time-to-merge.
One example of this has been #215, where a link in the http docs caused the client
session.id
PR to fail verifications.Suggestions:
The text was updated successfully, but these errors were encountered: