Make CI fail when the linkcheck of PR's fail #2004
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jgsogo
approved these changes
Jan 21, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We only fail the CI job if the linkcheck fails when the commit is merged to master. That avoids some spurious fails when the PR is made but is making that sometimes we do not detect broken links in the PR and after merging to master the job fails and the docs are not published.
Temporary we could disable that check so that the PR's fail (I think it's better to fail the PR even if it's caused by spurious fails).
IMHO in case that after the merge to master the job fails because we have spurious fails, or a link changed in between the PR was checked and the PR was merged, we should let the documentation be published and create an active alert system (slack, dashboard...) to fix the problem as soon as possible. We could also let the job fail and don't publish the docs, then through the alert system fix the problem, but my personal preference is publishing even if we have one or two links broken for a couple of hours. We should discuss the best strategy.
This PR should fail first. Then after the broken links are fixed, it should pass.
Please @uilianries, be aware that I had to put conan-community buildroot link back because the buildroot example is not merged yet on the new repo. This should be fixed when it's merged.