Improve readme builder for carvel pkgs #4138
Merged
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
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
21 tasks
Merged
absoludity
approved these changes
Jan 24, 2022
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.
Description of the change
Since Carvel packages do not have any
readmefield, we decided to build one on our own. In the initial implementation, we simply populated a markdown template regardless of the existence (or not) of the given fields.Also, some arrays and date types weren't being considered.
This PR is to slightly improve the look n' feel of the installation page
Benefits
Better readme.
Possible drawbacks
N/A
Applicable issues
Additional information
Before:
After: