1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
---
title: Template fields
description: Explain Renovate template fields
---
# 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](https://handlebarsjs.com/) 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.
## Exposed config options
<!-- Autogenerate in https://github.com/renovatebot/renovate -->
<!-- Autogenerate end -->
<!-- Automatically insert exposed configuration options here -->
## Other available fields
<!-- Autogenerate in https://github.com/renovatebot/renovate -->
<!-- Autogenerate end -->
<!-- Insert runtime fields here -->
## Additional Handlebars helpers
### and
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`.
### containsString
Returns `true` if a given string is a substring.
`{{#if (containsString depName 'python')}}Python{{else}}Other{{/if}}`
### decodeURIComponent
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()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent) to learn more.
### distinct
Removes duplicate elements from an array.
`{{#each (distinct (lookupArray (lookupArray upgrades "prBodyDefinitions") "Issue"))}} {{{.}}}{{/each}}`
### encodeBase64
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.
### encodeURIComponent
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()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) to learn more.
### equals
Returns `true` if two values equals (checks strict equality, i.e. `===`).
`{{#if (equals datasource 'git-refs')}}git-refs{{else}}Other{{/if}}`
### lookupArray
Similar to the built-in [`lookup`](https://handlebarsjs.com/guide/builtin-helpers.html#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`.
### lowercase
The `lowercase` helper converts a given string to lower case.
`{{{ lowercase depName }}}`
### or
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}}`
### replace
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()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace) to learn more.
### split
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`.
### stringToPrettyJSON
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.
### toArray
If you want to convert elements to an array, use `toArray`, e.g.,
`{{{ toJSON (toArray 'value1' 'value2' 'value3') }}}` will render `["value1","value2","value3"]`.
### toJSON
If you want to convert an object to a JSON string, you can use the built-in function `toJSON` like this:
`{{{ toJSON upgrades }}}`
### toObject
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"}`.
## Environment variables
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`](./self-hosted-configuration.md#customenvvariables) config option.
You can also use the [`exposeAllEnv`](./self-hosted-configuration.md#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.
|
