Expose template metadata in the template rendering. #2179
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
foot
reviewed
Jan 6, 2023
| @@ -329,3 +332,13 @@ func makeTemplateFunctions() template.FuncMap { | |||
| } | |||
| return f | |||
| } | |||
|
|
|||
| // this could add additional fields from the data. | |||
| func templateMetadata(t templatesv1.Template) map[string]any { | |||
There was a problem hiding this comment.
any is a new predeclared identifier and a type alias of interface{}.
Neat. I have also just repeated the word "any" too many times and it does not look right anymore.
foot
approved these changes
Jan 6, 2023
| @@ -242,7 +242,10 @@ func (p *TextTemplateProcessor) Render(tmpl []byte, values map[string]string) ([ | |||
| } | |||
|
|
|||
| var out bytes.Buffer | |||
| if err := parsed.Execute(&out, map[string]interface{}{"params": values}); err != nil { | |||
| if err := parsed.Execute(&out, map[string]interface{}{ | |||
There was a problem hiding this comment.
This seems to be the only template.Execute invocation in the codebase. Well done us.
This exposes some template metadata for the surrounding CAPI/GitOps template via the .template.meta key in the "templating" renderType.
bigkevmcd
force-pushed
the
template-object-meta
branch
from
156d2d8 to
5d503be
Compare
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.
Closes https://github.com/weaveworks/weave-gitops-interlock/issues/244
What changed?
This exposes some template metadata for the surrounding CAPI/GitOps template via the .template.meta key in the "templating" renderType.
The data can be used when rendering file paths etc.
Why was this change made?
Allow rendering templates to dynamically generated paths.
How was this change implemented?
I opted not to expose the entire
Templateresource, as a recent(ish) PR upstream got a review that highlighted that this binds the metadata to the struct too tightly.How did you validate the change?
Tests!
Release notes
Template path generation can now include metadata from the template when generating the output.
Documentation Changes
The user guide should include an example...
Currently, the template meta only includes the
namespaceandnamefields from the CAPITemplate.