Open arschles opened 8 years ago
@arschles this looks good!
My only suggestion, and this is a post-proposal, implementation detail, is to use .WorkflowDescription
as opposed to .WorkflowWarning
in the README.md
template example above. (The default description would then be the WARNING...
string (or whatever it may evolve to) and then it can be set to something else as shown in the example above.)
This issue was moved to teamhephy/deisrel#4
This issue is for using Go templates in
Chart.yaml
andREADME.md
files in helm charts so that deisrel doesn't have to do string replacement, which is brittle. My proposal is to add agenerate_metadata.toml
in the same directory as theREADME.md
and theChart.yaml
, and make the latter two files into Go templates.deisrel
would then get a new command that reads thegenerate_metadata.toml
and generates theREADME.md
andChart.yaml
templates based on the values in that file.In this new scheme, a new
workflow-tpl
folder would be created in the https://github.com/deis/charts repository. That repo would have aREADME.md
that looks similar to the below, with a similarChart.yaml
file as well.A version-specific file would be created by the releaser to cut a new chart. This file would not necessarily need to be checked in to any source control, because it's only used once. See below for a sample:
With those changes in place, the
deisrel
command to create a new template would be as follows:This command would not only create a new chart based on
workflow-2.1.0-metadata.toml
, it would also adjust thetpl/generate_params.toml
so thathelmc generate
can correctly generate new manifests when the user is installing deis workflow. The latter is current behavior of deisrel.cc/ @vdice for thoughts and feedback