fix(java-templates): custom templates needs to load partial metadata #788
Conversation
This file contains 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
google-cla
bot
added
the
cla: yes
thiagotnunes
approved these changes
Oct 7, 2020
stephaniewang526
approved these changes
Oct 7, 2020
bcoe
approved these changes
Oct 8, 2020
bcoe
reviewed
Oct 8, 2020
| def load_partials(files: List[str] = _DEFAULT_PARTIAL_FILES) -> Dict: | ||
| """ | ||
| hand-crafted artisinal markdown can be provided in a .readme-partials.yml. | ||
| The following fields are currently supported: |
There was a problem hiding this comment.
I like this refactor 👍
It might be worth running the branch against one Node.js repo that uses partials, just to make sure it behaves as expected.
There was a problem hiding this comment.
Ran this against nodejs-storage and it succeeded with no changes to the README.md
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.
Refactors partial parsing into a separate module for re-use.
For java, we are using
CommonTemplates.render()which does not include any magic metadata loading likeCommonTemplates._generic_library()does. Instead allow the partial yaml parsing to be used externally and explicitly load the partial metadata in thejava.custom_templates()helper. This fixes the README generation from our README autosynth.Fixes #791