This repository has been archived by the owner on Mar 24, 2023. It is now read-only.
support for passing readme in values yaml #880
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
dexhorthy
force-pushed
the
values-readme
branch
from
f61ce1c
to
e997775
Compare
dexhorthy
force-pushed
the
values-readme
branch
from
e997775
to
3af4b56
Compare
dexhorthy
commented
Mar 25, 2019
| @@ -18,6 +18,9 @@ lifecycle: | |||
| strip_path: true | |||
| - helmValues: | |||
| path: installer/consul/values.yaml | |||
| readme: | |||
| contents: | | |||
| # Fake readme :) | |||
There was a problem hiding this comment.
modified these tests so we have integration coverage on that field being supported in the YAML unmarshal.
dexhorthy
commented
Mar 25, 2019
| // if there's a readme, default to readme tab. Else default to linter results. | ||
| const showHelp = !this.props.readme; | ||
| const showPreview = !showHelp; | ||
| this.state = { showHelp, showPreview }; |
There was a problem hiding this comment.
This was not directly related but I don't think it makes sense to default to the readme tab if its empty (which happens in non init-chart workflows).
divolgin
approved these changes
Mar 25, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What I Did
Allow app maintainers to override the readme shown in a
helmValuesstep.Right now the UI reads this from the
/metadataendpoint, but now a mantainer can override this.How I Did it
readme.contentsas an optional field tolifecycle.v1.helmValuesreadmeis non null on the step, set the values ofdaemontypes.HelmValues.Readmewhen returning it down to the frontend.readmefield on the step, otherwise uses areadmefrom the chart meta if present.How to verify it
Use a lifecycle like the following, and navigate to helm values step:
Description for the Changelog
Allow app maintainers to override the readme shown in a
helmValuesstep.🚢