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:
- Only run the markdown link check against markdown files that have changed in the PR
- Instead of running on PRs, only run on a schedule across the whole repo and open an issue when the checker fails
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.idPR to fail verifications.Suggestions: