Teach Kibana link checking about PR features #898
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
The docs build has three features when building all books: 1. If you specify `--keep_hash` we reuse the hash of the source repos for every book that we've built before. This is useful for rebuilding only the books that we converted to asciidoctor. Or in combination with `--sub_dir` 2. If you specify `--sub_dir` we use a directory instead of a commit hash from some source repo. This is mostly useful in combination with `--keep_hash` because when you use those together your can rebuild the docs as though you committed the directory that you are subsituting. It makes for perfect pull request tests. 3. We automatically check all of the links, including links from some typescript files in the kibana repo. The trouble is that the kibana repo link checking process didn't understand `--keep_hash` and `--sub_dir`. This commit changes that. The bulk of it the change is testing the link checking, which we didn't really have any of up until now. Closes elastic#892
estolfo
reviewed
May 24, 2019
| kibana_repo.write KIBANA_LINKS_FILE, <<~JS | ||
| export const documentationLinks = { | ||
| foo: `${ELASTIC_WEBSITE_URL}guide/foo`, | ||
| }; |
There was a problem hiding this comment.
I almost called out this semicolon but then realized this was javascript = )
estolfo
approved these changes
May 24, 2019
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.
The docs build has three features when building all books:
--keep_hashwe reuse the hash of the source reposfor every book that we've built before. This is useful for rebuilding
only the books that we converted to asciidoctor. Or in combination with
--sub_dir--sub_dirwe use a directory instead of a commithash from some source repo. This is mostly useful in combination with
--keep_hashbecause when you use those together your can rebuild thedocs as though you committed the directory that you are subsituting. It
makes for perfect pull request tests.
typescript files in the kibana repo.
The trouble is that the kibana repo link checking process didn't
understand
--keep_hashand--sub_dir. This commit changes that. Thebulk of it the change is testing the link checking, which we didn't
really have any of up until now.
Closes #892