| title | description |
|---|---|
Template fields |
Explain Renovate template fields |
In order to provide flexible configuration, Renovate supports using "templates" for certain fields like addLabels, branchName, extractVersionTemplate, labels.
Renovate's templates use handlebars under the hood.
You can recognize templates when you see strings like {{depName}} in configuration fields.
Below you can find lists of fields/values that you can use in templates. Some are configuration options passed through, while others are generated as part of Renovate's run.
logJSON and releases are only allowed in commitBody template.
Returns true only if all expressions are true.
{{#if (and isMajor hasReleaseNotes)}}Backwards Incompatible release! Check out the Release notes.{{/if}}
In the example above, it will only show a text if isMajor=true and hasReleaseNotes=true.
Returns true if a given string is a substring.
{{#if (containsString depName 'python')}}Python{{else}}Other{{/if}}
If you want to decode a percent-encoded string, use the built-in function decodeURIComponent like this:
{{{decodeURIComponent depName}}}
In the example above depName is the string you want to decode.
Read the MDN Web Docs, decodeURIComponent() to learn more.
Removes duplicate elements from an array.
{{#each (distinct (lookupArray (lookupArray upgrades "prBodyDefinitions") "Issue"))}} {{{.}}}{{/each}}
If you want to convert a string to Base64, use the built-in function encodeBase64 like this:
{{{encodeBase64 body}}}
In the example above body is the string you want to transform into a Base64-encoded value.
If you want to convert a string to a valid URI, use the built-in function encodeURIComponent like this:
{{{encodeURIComponent baseDir}}}
In the example above baseDir is the string you want to transform into a valid URI.
Read the MDN Web Docs, encodeURIComponent() to learn more.
Returns true if two values equals (checks strict equality, i.e. ===).
{{#if (equals datasource 'git-refs')}}git-refs{{else}}Other{{/if}}
Similar to the built-in lookup
helper, but performs lookups in every element of an array, instead of just one object.
For example:
{{#each (lookupArray upgrades "prBodyDefinitions")}} {{{Issue}}}{{/each}}
will produce the same output as:
{{#each upgrades}}{{#with prBodyDefinitions}} {{{Issue}}}{{/with}}{{/each}}.
The return value of lookupArray can be passed to other helpers - for example,
to distinct.
The lowercase helper converts a given string to lower case.
{{{ lowercase depName }}}
Returns true if at least one expression is true.
{{#if (or isPatch isSingleVersion}}Small update, safer to merge and release.{{else}}Check out the changelog for all versions before merging!{{/if}}
The replace helper replaces all found strings matching the given regex with the replacement string.
If you want to replace some characters in a string, use the built-in function replace like this:
{{{replace '[a-z]+\.github\.com' 'ghc' depName}}}
In the example above all matches of the regex [a-z]+\.github\.com will be replaced by ghc in depName.
Read the MDN Web Docs, String.prototype.replace() to learn more.
Splits a string into an array of substrings.
This example splits a package name by - and gets the second part:
{{ lookup (split packageName '-') 1 }}
An input of foo-bar-test therefor would return bar.
If you want to print pretty JSON with Handlebars you can use the built-in function stringToPrettyJSON like this:
{{{stringToPrettyJSON myvar}}}
In the example above myvar is a variable/field, that has valid JSON.
If you want to convert elements to an array, use toArray, e.g.,
{{{ toJSON (toArray 'value1' 'value2' 'value3') }}} will render ["value1","value2","value3"].
If you want to convert an object to a JSON string, you can use the built-in function toJSON like this:
{{{ toJSON upgrades }}}
If you want to convert key-value pairs to an object, use toObject, e.g.,
{{{ toJSON (toObject 'key1' 'value1' 'key2' 'value2') }}} will render {"key1":"value1","key2":"value2"}.
By default, you can only access a handful of basic environment variables like HOME or PATH.
This is for security reasons.
HOME is {{env.HOME}}
If you're self-hosting Renovate, you can expose more variables with the customEnvVariables config option.
You can also use the exposeAllEnv config option to allow all environment variables in templates, but make sure to consider the security implications of giving the scripts unrestricted access to all variables.