Add source_branch attribute #1147
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 `source_branch` attribute should be useful in resolving inter-book links. We can get this *perfect* when we're running with `--all` because every book already *has* a branch attribute. When we build with `--doc` we have to guess. I've added some heuristics that I feal are likely to guess right most of the time for most folks. I'm not too worried about guessing wrong *sometimes* because, for the most part, that'll only break interbook links and lots of folks don't check those locally anyway. And because we have the pull request tests which run with `--all` so they'll serve as an accurate backstop. Relates to elastic#804
Member
Author
|
@olksdr I went "full perl" on this one. The only difficult part of this is the regular expression. And the testing. |
Member
Author
|
Oooh good catch past-me! |
Member
Author
|
Wrote a test for that weird case. |
Contributor
|
When I remove the source_branch attribute from elastic/stack-docs#493, the Stack Overview still builds successfully. Therefore, this LGTM |
Member
Author
|
Thanks for reviewing @olksdr! |
This was referenced Sep 6, 2019
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
source_branchattribute should be useful in resolving inter-booklinks. We can get this perfect when we're running with
--allbecauseevery book already has a branch attribute. When we build with
--docwe have to guess. I've added some heuristics that I feal are likely to
guess right most of the time for most folks. I'm not too worried about
guessing wrong sometimes because, for the most part, that'll only
break interbook links and lots of folks don't check those locally
anyway. And because we have the pull request tests which run with
--allso they'll serve as an accurate backstop.Relates to #804