ci: Break CI build on broken links, ommitted files #95
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
Mkdocs is able to detect broken links or files ommitted from the "nav" configuration, etc. By default, it reports them at the "INFO" level. Instead, we can have "mkdocs build" report them as warnings. To do so, we follow the documentation's "recommended settings for most sites (maximal strictness)" (see link). Once "mkdocs build" emits warnings for these issues, we can use the strict mode (-s|--strict) to have the build error out if anything looks wrong. Let's use this in CI to detect broken links, for example. Link: https://www.mkdocs.org/user-guide/configuration/#validation Signed-off-by: Quentin Monnet <qmo@qmon.net>
qmonnet
force-pushed
the
pr/qmonnet/validate-links
branch
from
52a5065 to
2f9bf52
Compare
|
I brought this up to @Frostman since he is looking at modifying this area of the code / docs. |
|
that looks super useful, is it possible to ignore the files with generated docs to not wait for fixing it? |
I don't think there is an easy way to selectively disable validation for specific files, at least I couldn't find any. There are few broken links in right now, only 4 as far as I remember, so maybe not too hard to fix. I looked into it some time ago, see githedgehog/fabric#809 for more context. |
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.
Mkdocs is able to detect broken links or files ommitted from the "nav" configuration, etc. By default, it reports them at the "INFO" level. Instead, we can have "mkdocs build" report them as warnings. To do so, we follow the documentation's "recommended settings for most sites (maximal strictness)" (see docs)
Once "mkdocs build" emits warnings for these issues, we can use the strict mode (-s|--strict) to have the build error out if anything looks wrong. Let's use this in CI to detect broken links, for example.
Warning
Doesn't pass CI yet, because we currently have a few broken links in the API reference. See githedgehog/fabric#809.