Add inbound links validation #587
Merged
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.
Adds two commands to
docs-assembler
and
validate-inbound-all
Validates all repositories published to the link index. Each
links.json
hascross_links
section declaring all cross links used in that docset. This command will validate each cross link actually still resolves.validate-inbound-local
Similarly this validates all published cross_links still resolve using a local
links.json
file to override the definition for a given repository.This is exposed as a github action:
Which may be called after a documentation build. Will hook this up to be part of the default publish flow in a follow up PR.
This will only validate crosslinks to the current repository. So a failure in one repository shouldn't fail all repositories.