feat(templates): allow templating in template path #6736
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
stefreak
reviewed
Dec 20, 2024
thsig
force-pushed
the
add-template-path-to-parent-context
branch
from
7df72a3 to
5451d21
Compare
thsig
force-pushed
the
add-template-path-to-parent-context
branch
5 times, most recently
from
0295e2a to
0139ab9
Compare
Added a new template variable for `RenderTemplate` configs:
`${template.path}`. This is the relative path from the project root
to the config template being rendered. This is useful when you want
to use the full path to a file or directory next to the
`ConfigTemplate` that's being rendered (e.g. to use a shared
Dockerfile that belongs the template, every time you render that
template).
thsig
force-pushed
the
add-template-path-to-parent-context
branch
from
0139ab9 to
43d65fb
Compare
stefreak
reviewed
Feb 24, 2025
| this.name = name | ||
|
|
||
| if (isAbsolute(params.path)) { | ||
| throw new InternalError({ message: `Template path must be relative path from project root, got ${params.path}` }) |
There was a problem hiding this comment.
is this error indicating a bug in our programming? If not & it indicates a problem with the users configuration, it should be a ConfigurationError
Comment on lines
367
to
+369
| resource.internal.parentName = renderConfig.name | ||
| resource.internal.templateName = template.name | ||
| resource.internal.templatePath = getRelativeTemplatePath(garden.projectRoot, template.internal.configFilePath) |
There was a problem hiding this comment.
Can we maybe encapsulate all three values in a single optional template property? Then we can remove all those places where we have to throw, as if template is defined, parentName, templateName and templatePath would all be required.
There was a problem hiding this comment.
Yeah, I agree. I was thinking just that as I wrote this PR. I'll make that change.
| @@ -228,10 +229,12 @@ describe("config templates", () => { | |||
| const module = resolved.modules[0] | |||
|
|
|||
| expect(module.name).to.equal("test-test-bar") | |||
| // TODO-DODDI: Here, we need to be actually verifying that the right values come through when resolved! | |||
There was a problem hiding this comment.
you could instantiate an appropriate context in this (or another) test & deepEvaluate the template string to see what happens
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.
What this PR does / why we need it:
Added a new template variable for
RenderTemplateconfigs:${template.path}. This is the relative path (from the project root) to the config template being rendered. This is useful when you want to use the full path to a file or directory next to theConfigTemplatethat's being rendered (e.g. to use a shared Dockerfile that belongs the template, every time you render that template).Which issue(s) this PR fixes:
Addresses a limitation raised by a user on Discord: https://discord.com/channels/817392104711651328/1318995192501764151