Newer
Older
# Configuration
## Configuration Methods
Configuration is supported via any or all of the below:
- Configuration file
- Environment
- CLI
- `renovate.json` in target repository
- `renovate` field of `package.json` in target repository
i.e. `package.json` settings will override `renovate.json` settings, CLI, which overrides env, which overrides the config file, which overrides defaults.
Default configuration values can be found in [lib/config/definitions.js](../lib/config/definitions.js)
### Configuration File
You can override default configuration using a configuration file, with default name `config.js` in the working directory. If you need an alternate location or name, set it in the environment variable `RENOVATE_CONFIG_FILE`.
Using a configuration file gives you very granular configuration options. For instance, you can override most settings at the global (file), repository, or package level. e.g. apply one set of labels for `backend/package.json` and a different set for `frontend/package.json` in the same repository.
```javascript
module.exports = {
depTypes: ['dependencies', 'devDependencies'],
repositories: [
{
repository: 'singapore/repo1',
packageFiles: [
'package.json',
{
depTypes: [
'dependencies',
'devDependencies',
{
depType: 'optionalDependencies',
labels: ['renovate', 'optional'],
},
],
],
packages: [
{
package: 'jquery',
labels: ['jquery', 'uhoh'],
},
],
$ node renovate --help
Usage: renovate [options] [repositories...]
--log-level <string> Logging level
--log-file <string> Log file path
--log-file-level <string> Log file log level
--onboarding [boolean] Require a Configuration PR first
--private-key <string> Server-side private key
--encrypted <json> A configuration object containing configuration encrypted with project key
--timezone <string> [IANA Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
--onboarding [boolean] Require a Configuration PR first
--platform <string> Platform type of repository
--endpoint <string> Custom endpoint to use
--token <string> Repository Auth Token
--npmrc <string> String copy of npmrc file. Use \n instead of line breaks
--yarnrc <string> String copy of yarnrc file. Use \n instead of line breaks
--ignore-npmrc-file [boolean] Whether to ignore any .npmrc file found in repository
--autodiscover [boolean] Autodiscover all repositories
--autodiscover [boolean] Autodiscover all repositories
--github-app-id <integer> GitHub App ID (enables GitHub App functionality if set)
--github-app-key <string> GitHub App Private Key (.pem file contents)
--package-files <list> Package file paths
--ignore-paths <list> Skip any package.json whose path matches one of these.
--ignore-deps <list> Dependencies to ignore
--pin-versions [boolean] Convert ranged versions in package.json to pinned versions
--separate-major-releases [boolean] If set to false, it will upgrade dependencies to latest release only, and not separate major/minor branches
--separate-patch-releases [boolean] If set to true, it will separate minor and patch updates into separate branches
--ignore-future [boolean] Ignore versions tagged as "future"
--ignore-unstable [boolean] Ignore versions with unstable semver
--respect-latest [boolean] Ignore versions newer than npm "latest" version
--branch-prefix <string> Prefix to use for all branch names
--semantic-commits [boolean] Enable semantic commit prefixes for commits and PR titles
--semantic-prefix <string> Prefix to use if semantic commits are enabled
--recreate-closed [boolean] Recreate PRs even if same ones were closed previously
--rebase-stale-prs [boolean] Rebase stale PRs (GitHub only)
--unpublish-safe [boolean] Set a status check for unpublish-safe upgrades
--pr-creation <string> When to create the PR for a branch. Values: immediate, not-pending, status-success.
--pr-not-pending-hours <integer> Timeout in hours for when prCreation=not-pending
--automerge [boolean] Whether to automerge branches/PRs automatically, without human intervention
--automerge-type <string> How to automerge - "branch-merge-commit", "branch-push" or "pr". Branch support is GitHub-only
--lazy-grouping [boolean] Use group names only when multiple dependencies upgraded
--group-name <string> Human understandable name for the dependency group
--labels <list> Labels to add to Pull Request
--assignees <list> Assignees for Pull Request
--reviewers <list> Requested reviewers for Pull Requests (GitHub only)
--meteor <json> Configuration object for meteor package.js renovation
-h, --help output usage information
Examples:
$ renovate --token abc123 singapore/lint-condo
$ renovate --labels=renovate,dependency --ignore-unstable=false --log-level verbose singapore/lint-condo
$ renovate singapore/lint-condo singapore/package-test
To configure any `<list>` items, separate with commas. E.g. `renovate --labels=renovate,dependency`.
### renovate.json
If you add a `renovate.json` file to the root of your repository, you can use this to override default settings.
If you leave the `packageFiles` field empty then `renovate` will still auto-discover all `package.json` files in the repository.
### package.json
If you add configuration options to your `package.json` then these will override any other settings above.
Obviously, you can't set repository or package file location with this method.
```json
"renovate": {
"labels": [
"upgrade",
"bot"
]
}
```
## Configuration Options
<table>
<tr>
<th>Name</th>
<th>Description</th>
<th>Type</th>
<th>Default value</th>
<th>Environment</th>
<th>CLI</th>
</tr>
<tr>
<td>`extends`</td>
<td>Configuration presets to use/extend</td>
<td>list</td>
<td><pre>[]</pre></td>
<td>`RENOVATE_EXTENDS`</td>
<td><td>
</tr>
<tr>
<td>`description`</td>
<td>Plain text description for a config or preset</td>
<td>list</td>
<td><pre>[]</pre></td>
<td></td>
<td><td>
</tr>
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
<tr>
<td>`enabled`</td>
<td>Enable or disable renovate</td>
<td>boolean</td>
<td><pre>true</pre></td>
<td></td>
<td><td>
</tr>
<tr>
<td>`logLevel`</td>
<td>Logging level</td>
<td>string</td>
<td><pre>"info"</pre></td>
<td>`LOG_LEVEL`</td>
<td>`--log-level`<td>
</tr>
<tr>
<td>`logFile`</td>
<td>Log file path</td>
<td>string</td>
<td><pre>null</pre></td>
<td>`RENOVATE_LOG_FILE`</td>
<td>`--log-file`<td>
</tr>
<tr>
<td>`logFileLevel`</td>
<td>Log file log level</td>
<td>string</td>
<td><pre>"debug"</pre></td>
<td>`RENOVATE_LOG_FILE_LEVEL`</td>
<td>`--log-file-level`<td>
</tr>
<tr>
<td>`onboarding`</td>
<td>Require a Configuration PR first</td>
<td>boolean</td>
<td><pre>true</pre></td>
<td>`RENOVATE_ONBOARDING`</td>
<td>`--onboarding`<td>
</tr>
<tr>
<td>`privateKey`</td>
<td>Server-side private key</td>
<td>string</td>
<td><pre>null</pre></td>
<td>`RENOVATE_PRIVATE_KEY`</td>
<td>`--private-key`<td>
</tr>
<tr>
<td>`encrypted`</td>
<td>A configuration object containing configuration encrypted with project key</td>
<td>json</td>
<td><pre>null</pre></td>
<td>`RENOVATE_ENCRYPTED`</td>
<td>`--encrypted`<td>
</tr>
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
<tr>
<td>`timezone`</td>
<td>[IANA Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)</td>
<td>string</td>
<td><pre>null</pre></td>
<td>`RENOVATE_TIMEZONE`</td>
<td>`--timezone`<td>
</tr>
<tr>
<td>`schedule`</td>
<td>Times of day/week to renovate</td>
<td>list</td>
<td><pre>[]</pre></td>
<td></td>
<td><td>
</tr>
<tr>
<td>`onboarding`</td>
<td>Require a Configuration PR first</td>
<td>boolean</td>
<td><pre>true</pre></td>
<td>`RENOVATE_ONBOARDING`</td>
<td>`--onboarding`<td>
</tr>
<tr>
<td>`platform`</td>
<td>Platform type of repository</td>
<td>string</td>
<td><pre>"github"</pre></td>
<td>`RENOVATE_PLATFORM`</td>
<td>`--platform`<td>
</tr>
<tr>
<td>`endpoint`</td>
<td>Custom endpoint to use</td>
<td>string</td>
<td><pre>null</pre></td>
<td>`RENOVATE_ENDPOINT`</td>
<td>`--endpoint`<td>
</tr>
<tr>
<td>`token`</td>
<td>Repository Auth Token</td>
<td>string</td>
<td><pre>null</pre></td>
<td>`RENOVATE_TOKEN`</td>
<td>`--token`<td>
</tr>
<tr>
<td>`npmrc`</td>
<td>String copy of npmrc file. Use \n instead of line breaks</td>
<td>string</td>
<td><pre>null</pre></td>
<td>`RENOVATE_NPMRC`</td>
<td>`--npmrc`<td>
</tr>
<tr>
<td>`yarnrc`</td>
<td>String copy of yarnrc file. Use \n instead of line breaks</td>
<td>string</td>
<td><pre>null</pre></td>
<td>`RENOVATE_YARNRC`</td>
<td>`--yarnrc`<td>
</tr>
<tr>
<td>`ignoreNpmrcFile`</td>
<td>Whether to ignore any .npmrc file found in repository</td>
<td>boolean</td>
<td><pre>false</pre></td>
<td>`RENOVATE_IGNORE_NPMRC_FILE`</td>
<td>`--ignore-npmrc-file`<td>
</tr>
<tr>
<td>`autodiscover`</td>
<td>Autodiscover all repositories</td>
<td>boolean</td>
<td><pre>false</pre></td>
<td>`RENOVATE_AUTODISCOVER`</td>
<td>`--autodiscover`<td>
</tr>
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<tr>
<td>`autodiscover`</td>
<td>Autodiscover all repositories</td>
<td>boolean</td>
<td><pre>false</pre></td>
<td>`RENOVATE_AUTODISCOVER`</td>
<td>`--autodiscover`<td>
</tr>
<tr>
<td>`githubAppId`</td>
<td>GitHub App ID (enables GitHub App functionality if set)</td>
<td>integer</td>
<td><pre>undefined</pre></td>
<td>`RENOVATE_GITHUB_APP_ID`</td>
<td>`--github-app-id`<td>
</tr>
<tr>
<td>`githubAppKey`</td>
<td>GitHub App Private Key (.pem file contents)</td>
<td>string</td>
<td><pre>null</pre></td>
<td>`RENOVATE_GITHUB_APP_KEY`</td>
<td>`--github-app-key`<td>
</tr>
<tr>
<td>`repositories`</td>
<td>List of Repositories</td>
<td>list</td>
<td><pre>[]</pre></td>
<td>`RENOVATE_REPOSITORIES`</td>
<td><td>
</tr>
<tr>
<td>`baseBranch`</td>
<td>Base branch to target for Pull Requests. Otherwise default branch is used</td>
<td>string</td>
<td><pre>null</pre></td>
<td></td>
<td><td>
</tr>
<tr>
<td>`packageFiles`</td>
<td>Package file paths</td>
<td>list</td>
<td><pre>[]</pre></td>
<td>`RENOVATE_PACKAGE_FILES`</td>
<td>`--package-files`<td>
</tr>
<tr>
<td>`ignorePaths`</td>
<td>Skip any package.json whose path matches one of these.</td>
<td>list</td>
<td><pre>["node_modules/"]</pre></td>
<td>`RENOVATE_IGNORE_PATHS`</td>
<td>`--ignore-paths`<td>
</tr>
<td>`dependencies`</td>
<td>Configuration specifically for `package.json`>`dependencies`</td>
<td>json</td>
<td><pre>{"semanticPrefix": "fix(deps):"}</pre></td>
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
<td>`RENOVATE_DEPENDENCIES`</td>
<td><td>
</tr>
<tr>
<td>`devDependencies`</td>
<td>Configuration specifically for `package.json`>`devDependencies`</td>
<td>json</td>
<td><pre>{}</pre></td>
<td>`RENOVATE_DEV_DEPENDENCIES`</td>
<td><td>
</tr>
<tr>
<td>`optionalDependencies`</td>
<td>Configuration specifically for `package.json`>`optionalDependencies`</td>
<td>json</td>
<td><pre>{}</pre></td>
<td>`RENOVATE_OPTIONAL_DEPENDENCIES`</td>
<td><td>
</tr>
<tr>
<td>`peerDependencies`</td>
<td>Configuration specifically for `package.json`>`peerDependencies`</td>
<td>json</td>
<td><pre>{"enabled": false}</pre></td>
<td>`RENOVATE_PEER_DEPENDENCIES`</td>
<td><td>
</tr>
<tr>
<td>`ignoreDeps`</td>
<td>Dependencies to ignore</td>
<td>list</td>
<td><pre>[]</pre></td>
<td>`RENOVATE_IGNORE_DEPS`</td>
<td>`--ignore-deps`<td>
</tr>
<tr>
<td>`packageRules`</td>
<td>Rules for matching package names</td>
<td>list</td>
<td><pre>[]</pre></td>
<td></td>
<td><td>
</tr>
<td>`packageNames`</td>
<td>Package names to match. Valid only within `packageRules` object</td>
<td>list</td>
<td><pre>[]</pre></td>
<td></td>
<td><td>
</tr>
<tr>
<td>`excludePackageNames`</td>
<td>Package names to exclude. Valid only within `packageRules` object</td>
<td>list</td>
<td><pre>[]</pre></td>
<td></td>
<td><td>
</tr>
<tr>
<td>`packagePatterns`</td>
<td>Package name patterns to match. Valid only within `packageRules` object.</td>
<td>list</td>
<td><pre>[]</pre></td>
<td></td>
<td><td>
</tr>
<tr>
<td>`excludePackagePatterns`</td>
<td>Package name patterns to exclude. Valid only within `packageRules` object.</td>
<td>list</td>
<td><pre>[]</pre></td>
<td></td>
<td><td>
</tr>
<tr>
<td>`pinVersions`</td>
<td>Convert ranged versions in package.json to pinned versions</td>
<td>boolean</td>
<td><pre>true</pre></td>
<td>`RENOVATE_PIN_VERSIONS`</td>
<td>`--pin-versions`<td>
</tr>
<tr>
<td>`separateMajorReleases`</td>
<td>If set to false, it will upgrade dependencies to latest release only, and not separate major/minor branches</td>
<td>boolean</td>
<td><pre>true</pre></td>
<td>`RENOVATE_SEPARATE_MAJOR_RELEASES`</td>
<td>`--separate-major-releases`<td>
</tr>
<tr>
<td>`separatePatchReleases`</td>
<td>If set to true, it will separate minor and patch updates into separate branches</td>
<td>boolean</td>
<td><pre>false</pre></td>
<td>`RENOVATE_SEPARATE_PATCH_RELEASES`</td>
<td>`--separate-patch-releases`<td>
</tr>
<tr>
<td>`ignoreFuture`</td>
<td>Ignore versions tagged as "future"</td>
<td>boolean</td>
<td><pre>true</pre></td>
<td>`RENOVATE_IGNORE_FUTURE`</td>
<td>`--ignore-future`<td>
</tr>
<tr>
<td>`ignoreUnstable`</td>
<td>Ignore versions with unstable semver</td>
<td>boolean</td>
<td><pre>true</pre></td>
<td>`RENOVATE_IGNORE_UNSTABLE`</td>
<td>`--ignore-unstable`<td>
</tr>
<tr>
<td>`respectLatest`</td>
<td>Ignore versions newer than npm "latest" version</td>
<td>boolean</td>
<td><pre>true</pre></td>
<td>`RENOVATE_RESPECT_LATEST`</td>
<td>`--respect-latest`<td>
</tr>
<tr>
<td>`branchPrefix`</td>
<td>Prefix to use for all branch names</td>
<td>string</td>
<td><pre>"renovate/"</pre></td>
<td>`RENOVATE_BRANCH_PREFIX`</td>
<td>`--branch-prefix`<td>
</tr>
<tr>
<td>`major`</td>
<td>Configuration to apply when an update type is major</td>
<td>json</td>
<td><pre>{}</pre></td>
<td>`RENOVATE_MAJOR`</td>
<td><td>
</tr>
<tr>
<td>`minor`</td>
<td>Configuration to apply when an update type is minor</td>
<td>json</td>
<td><pre>{}</pre></td>
<td>`RENOVATE_MINOR`</td>
<td><td>
</tr>
<tr>
<td>`patch`</td>
<td>Configuration to apply when an update type is patch. Only applies if `separatePatchReleases` is set to true</td>
<td>json</td>
<td><pre>{
"branchName": "{{branchPrefix}}{{depName}}-{{newVersionMajor}}.{{newVersionMinor}}.x"
}</pre></td>
<td>`RENOVATE_PATCH`</td>
<td><td>
</tr>
<tr>
<td>`pin`</td>
<td>Configuration to apply when an update type is pin.</td>
<td>json</td>
<td><pre>{
"automerge": true,
"unpublishSafe": false,
"groupName": "Pin Dependencies",
"group": {"prTitle": "{{groupName}}", "semanticPrefix": "refactor(deps):"}
}</pre></td>
<td>`RENOVATE_PIN`</td>
<td><td>
</tr>
<tr>
<td>`semanticCommits`</td>
<td>Enable semantic commit prefixes for commits and PR titles</td>
<td>boolean</td>
<td><pre>null</pre></td>
<td>`RENOVATE_SEMANTIC_COMMITS`</td>
<td>`--semantic-commits`<td>
</tr>
<tr>
<td>`semanticPrefix`</td>
<td>Prefix to use if semantic commits are enabled</td>
<td>string</td>
<td>`RENOVATE_SEMANTIC_PREFIX`</td>
<td>`--semantic-prefix`<td>
</tr>
<tr>
<td>`recreateClosed`</td>
<td>Recreate PRs even if same ones were closed previously</td>
<td>boolean</td>
<td><pre>false</pre></td>
<td>`RENOVATE_RECREATE_CLOSED`</td>
<td>`--recreate-closed`<td>
</tr>
<tr>
<td>`rebaseStalePrs`</td>
<td>Rebase stale PRs (GitHub only)</td>
<td>boolean</td>
<td><pre>false</pre></td>
<td>`RENOVATE_REBASE_STALE_PRS`</td>
<td>`--rebase-stale-prs`<td>
</tr>
<tr>
<td>`unpublishSafe`</td>
<td>Set a status check for unpublish-safe upgrades</td>
<td>boolean</td>
<td><pre>false</pre></td>
<td>`RENOVATE_UNPUBLISH_SAFE`</td>
<td>`--unpublish-safe`<td>
</tr>
<tr>
<td>`prCreation`</td>
<td>When to create the PR for a branch. Values: immediate, not-pending, status-success.</td>
<td>string</td>
<td><pre>"immediate"</pre></td>
<td>`RENOVATE_PR_CREATION`</td>
<td>`--pr-creation`<td>
</tr>
<tr>
<td>`prNotPendingHours`</td>
<td>Timeout in hours for when prCreation=not-pending</td>
<td>integer</td>
<td><pre>12</pre></td>
<td>`RENOVATE_PR_NOT_PENDING_HOURS`</td>
<td>`--pr-not-pending-hours`<td>
</tr>
<tr>
<td>`automerge`</td>
<td>Whether to automerge branches/PRs automatically, without human intervention</td>
<td>boolean</td>
<td><pre>false</pre></td>
<td>`RENOVATE_AUTOMERGE`</td>
<td>`--automerge`<td>
</tr>
<tr>
<td>`automergeType`</td>
<td>How to automerge - "branch-merge-commit", "branch-push" or "pr". Branch support is GitHub-only</td>
<td>string</td>
<td><pre>"pr"</pre></td>
<td>`RENOVATE_AUTOMERGE_TYPE`</td>
<td>`--automerge-type`<td>
</tr>
<tr>
<td>`requiredStatusChecks`</td>
<td>List of status checks that must pass before automerging. Set to null to enable automerging without tests.</td>
<td>list</td>
<td><pre>[]</pre></td>
<td></td>
<td><td>
</tr>
<tr>
<td>`branchName`</td>
<td>Branch name template</td>
<td>string</td>
<td><pre>"{{branchPrefix}}{{depName}}-{{newVersionMajor}}.x"</pre></td>
<td>`RENOVATE_BRANCH_NAME`</td>
<td><td>
</tr>
<tr>
<td>`commitMessage`</td>
<td>Commit message template</td>
<td>string</td>
<td><pre>"Update dependency {{depName}} to v{{newVersion}}"</pre></td>
<td>`RENOVATE_COMMIT_MESSAGE`</td>
<td><td>
</tr>
<tr>
<td>`prTitle`</td>
<td>Pull Request title template</td>
<td>string</td>
<td><pre>"{{#if isPin}}Pin{{else}}{{#if isRollback}}Roll back{{else}}Update{{/if}}{{/if}} dependency {{depName}} to {{#if isRange}}{{newVersion}}{{else}}{{#if isMajor}}v{{newVersionMajor}}{{else}}v{{newVersion}}{{/if}}{{/if}}"</pre></td>
<td>`RENOVATE_PR_TITLE`</td>
<td><td>
</tr>
<tr>
<td>`prBody`</td>
<td>Pull Request body template</td>
<td>string</td>
<td><pre>"This {{#if isGitHub}}Pull{{else}}Merge{{/if}} Request {{#if isRollback}}rolls back{{else}}updates{{/if}} dependency {{#if repositoryUrl}}[{{depName}}]({{repositoryUrl}}){{else}}`{{depName}}`{{/if}} from `v{{currentVersion}}` to `v{{newVersion}}`{{#if isRollback}}. This is necessary and important because `v{{currentVersion}}` cannot be found in the npm registry - probably because of it being unpublished.{{/if}}\n{{#if releases.length}}\n\n{{#if schedule}}\n**Note**: This PR was created on a configured schedule (\"{{schedule}}\"{{#if timezone}} in timezone `{{timezone}}`{{/if}}) and will not receive updates outside those times.\n{{/if}}\n\n### Commits\n\n<details>\n<summary>{{githubName}}</summary>\n\n{{#each releases as |release|}}\n#### {{release.version}}\n{{#each release.commits as |commit|}}\n- [`{{commit.shortSha}}`]({{commit.url}}) {{commit.message}}\n{{/each}}\n{{/each}}\n\n</details>\n{{/if}}\n\n{{#if hasErrors}}\n\n---\n\n### Errors\n\nRenovate encountered some errors when processing your repository, so you are being notified here even if they do not directly apply to this PR.\n\n{{#each errors as |error|}}\n- `{{error.depName}}`: {{error.message}}\n{{/each}}\n{{/if}}\n\n{{#if hasWarnings}}\n\n---\n\n### Warnings\n\nPlease make sure the following warnings are safe to ignore:\n\n{{#each warnings as |warning|}}\n- `{{warning.depName}}`: {{warning.message}}\n{{/each}}\n{{/if}}\n\n---\n\nThis {{#if isGitHub}}PR{{else}}MR{{/if}} has been generated by [Renovate Bot](https://renovateapp.com)."</pre></td>
<td>`RENOVATE_PR_BODY`</td>
<td><td>
</tr>
<tr>
<td>`lockFileMaintenance`</td>
<td>Configuration for lock file maintenance</td>
<td>json</td>
<td><pre>{
"recreateClosed": true,
"branchName": "{{branchPrefix}}lock-file-maintenance",
"commitMessage": "Update lock file",
"prTitle": "Lock file maintenance",
"prBody": "This {{#if isGitHub}}Pull{{else}}Merge{{/if}} Request updates `package.json` lock files to use the latest dependency versions.\n\n{{#if schedule}}\n**Note**: This PR was created on a configured schedule (\"{{schedule}}\"{{#if timezone}} in timezone `{{timezone}}`{{/if}}) and will not receive updates outside those times.\n{{/if}}\n\n{{#if hasErrors}}\n\n---\n\n### Errors\n\nRenovate encountered some errors when processing your repository, so you are being notified here even if they do not directly apply to this PR.\n\n{{#each errors as |error|}}\n- `{{error.depName}}`: {{error.message}}\n{{/each}}\n{{/if}}\n\n{{#if hasWarnings}}\n\n---\n\n### Warnings\n\nPlease make sure the following warnings are safe to ignore:\n\n{{#each warnings as |warning|}}\n- `{{warning.depName}}`: {{warning.message}}\n{{/each}}\n{{/if}}\n\n---\n\nThis {{#if isGitHub}}PR{{else}}MR{{/if}} has been generated by [Renovate Bot](https://renovateapp.com).",
"schedule": ["before 5am on monday"]
<td>`RENOVATE_LOCK_FILE_MAINTENANCE`</td>
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
<td><td>
</tr>
<tr>
<td>`lazyGrouping`</td>
<td>Use group names only when multiple dependencies upgraded</td>
<td>boolean</td>
<td><pre>true</pre></td>
<td>`RENOVATE_LAZY_GROUPING`</td>
<td>`--lazy-grouping`<td>
</tr>
<tr>
<td>`groupName`</td>
<td>Human understandable name for the dependency group</td>
<td>string</td>
<td><pre>null</pre></td>
<td>`RENOVATE_GROUP_NAME`</td>
<td>`--group-name`<td>
</tr>
<tr>
<td>`groupSlug`</td>
<td>Slug to use for group (e.g. in branch name). Will be calculated from groupName if null</td>
<td>string</td>
<td><pre>null</pre></td>
<td></td>
<td><td>
</tr>
<tr>
<td>`group`</td>
<td>Config if groupName is enabled</td>
<td>json</td>
<td><pre>{
"recreateClosed": true,
"branchName": "{{branchPrefix}}{{groupSlug}}",
"commitMessage": "Renovate {{groupName}} packages",
"prTitle": "Renovate {{groupName}} packages",
"prBody": "This {{#if isGitHub}}Pull{{else}}Merge{{/if}} Request renovates the package group \"{{groupName}}\".\n\n{{#if schedule}}\n**Note**: This PR was created on a configured schedule (\"{{schedule}}\"{{#if timezone}} in timezone `{{timezone}}`{{/if}}) and will not receive updates outside those times.\n{{/if}}\n\n{{#each upgrades as |upgrade|}}\n- {{#if repositoryUrl}}[{{upgrade.depName}}]({{upgrade.repositoryUrl}}){{else}}`{{depName}}`{{/if}}: from `{{upgrade.currentVersion}}` to `{{upgrade.newVersion}}`\n{{/each}}\n\n{{#unless isPin}}\n### Commits\n\n{{#each upgrades as |upgrade|}}\n{{#if upgrade.releases.length}}\n<details>\n<summary>{{upgrade.githubName}}</summary>\n{{#each upgrade.releases as |release|}}\n\n#### {{release.version}}\n{{#each release.commits as |commit|}}\n- [`{{commit.shortSha}}`]({{commit.url}}){{commit.message}}\n{{/each}}\n{{/each}}\n\n</details>\n{{/if}}\n{{/each}}\n{{/unless}}\n<br />\n\n{{#if hasErrors}}\n\n---\n\n### Errors\n\nRenovate encountered some errors when processing your repository, so you are being notified here even if they do not directly apply to this PR.\n\n{{#each errors as |error|}}\n- `{{error.depName}}`: {{error.message}}\n{{/each}}\n{{/if}}\n\n{{#if hasWarnings}}\n\n---\n\n### Warnings\n\nPlease make sure the following warnings are safe to ignore:\n\n{{#each warnings as |warning|}}\n- `{{warning.depName}}`: {{warning.message}}\n{{/each}}\n{{/if}}\n\n---\n\nThis {{#if isGitHub}}PR{{else}}MR{{/if}} has been generated by [Renovate Bot](https://renovateapp.com)."
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
}</pre></td>
<td></td>
<td><td>
</tr>
<tr>
<td>`labels`</td>
<td>Labels to add to Pull Request</td>
<td>list</td>
<td><pre>[]</pre></td>
<td>`RENOVATE_LABELS`</td>
<td>`--labels`<td>
</tr>
<tr>
<td>`assignees`</td>
<td>Assignees for Pull Request</td>
<td>list</td>
<td><pre>[]</pre></td>
<td>`RENOVATE_ASSIGNEES`</td>
<td>`--assignees`<td>
</tr>
<tr>
<td>`reviewers`</td>
<td>Requested reviewers for Pull Requests (GitHub only)</td>
<td>list</td>
<td><pre>[]</pre></td>
<td>`RENOVATE_REVIEWERS`</td>
<td>`--reviewers`<td>
</tr>
<tr>
<td>`meteor`</td>
<td>Configuration object for meteor package.js renovation</td>
<td>json</td>
<td>`RENOVATE_METEOR`</td>
<td>`--meteor`<td>
</tr>
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
<tr>
<td>`docker`</td>
<td>Configuration object for Dockerfile renovation</td>
<td>json</td>
<td><pre>{
"enabled": false,
"branchName": "{{branchPrefix}}docker-{{depName}}-{{currentTag}}",
"commitMessage": "Update {{depName}}:{{currentTag}} digest",
"prTitle": "Update Dockerfile image {{depName}}@{{currentTag}} digest",
"prBody": "This {{#if isGitHub}}Pull{{else}}Merge{{/if}} Request updates Docker base image `{{depName}}@{{currentTag}}` to the latest digest (`{{newDigest}}`).\n\n{{#if schedule}}\n**Note**: This PR was created on a configured schedule (\"{{schedule}}\"{{#if timezone}} in timezone `{{timezone}}`{{/if}}) and will not receive updates outside those times.\n{{/if}}\n\n{{#if hasErrors}}\n\n---\n\n### Errors\n\nRenovate encountered some errors when processing your repository, so you are being notified here even if they do not directly apply to this PR.\n\n{{#each errors as |error|}}\n- `{{error.depName}}`: {{error.message}}\n{{/each}}\n{{/if}}\n\n{{#if hasWarnings}}\n\n---\n\n### Warnings\n\nPlease make sure the following warnings are safe to ignore:\n\n{{#each warnings as |warning|}}\n- `{{warning.depName}}`: {{warning.message}}\n{{/each}}\n{{/if}}\n\n---\n\nThis {{#if isGitHub}}PR{{else}}MR{{/if}} has been generated by [Renovate Bot](https://renovateapp.com).",
"pin": {
"prTitle": "Pin Dockerfile image {{depName}}@{{currentTag}} digest",
"prBody": "This {{#if isGitHub}}Pull{{else}}Merge{{/if}} Request pins Docker base image `{{depName}}@{{currentTag}}` to use a digest (`{{newDigest}}`).\nThis digest will then be kept updated via Pull Requests whenever the image is updated on the Docker registry.\n\n{{#if schedule}}\n**Note**: This PR was created on a configured schedule (\"{{schedule}}\"{{#if timezone}} in timezone `{{timezone}}`{{/if}}) and will not receive updates outside those times.\n{{/if}}\n\n{{#if hasErrors}}\n\n---\n\n### Errors\n\nRenovate encountered some errors when processing your repository, so you are being notified here even if they do not directly apply to this PR.\n\n{{#each errors as |error|}}\n- `{{error.depName}}`: {{error.message}}\n{{/each}}\n{{/if}}\n\n{{#if hasWarnings}}\n\n---\n\n### Warnings\n\nPlease make sure the following warnings are safe to ignore:\n\n{{#each warnings as |warning|}}\n- `{{warning.depName}}`: {{warning.message}}\n{{/each}}\n{{/if}}\n\n---\n\nThis {{#if isGitHub}}PR{{else}}MR{{/if}} has been generated by [Renovate Bot](https://renovateapp.com).",
"groupName": "Pin Docker Digests",
"group": {
"prTitle": "Pin Docker digests",
"prBody": "This {{#if isGitHub}}Pull{{else}}Merge{{/if}} Request pins Dockerfiles to use image digests.\n\n{{#if schedule}}\n**Note**: This PR was created on a configured schedule (\"{{schedule}}\"{{#if timezone}} in timezone `{{timezone}}`{{/if}}) and will not receive updates outside those times.\n{{/if}}\n\n{{#each upgrades as |upgrade|}}\n- {{#if repositoryUrl}}[{{upgrade.depName}}]({{upgrade.repositoryUrl}}){{else}}`{{depName}}`{{/if}}: `{{upgrade.newDigest}}`\n{{/each}}\n\n{{#if hasErrors}}\n\n---\n\n### Errors\n\nRenovate encountered some errors when processing your repository, so you are being notified here even if they do not directly apply to this PR.\n\n{{#each errors as |error|}}\n- `{{error.depName}}`: {{error.message}}\n{{/each}}\n{{/if}}\n\n{{#if hasWarnings}}\n\n---\n\n### Warnings\n\nPlease make sure the following warnings are safe to ignore:\n\n{{#each warnings as |warning|}}\n- `{{warning.depName}}`: {{warning.message}}\n{{/each}}\n{{/if}}\n\n---\n\nThis {{#if isGitHub}}PR{{else}}MR{{/if}} has been generated by [Renovate Bot](https://renovateapp.com)."
}
},
"group": {
"prTitle": "Update Docker {{groupName}} digests",
"prBody": "This {{#if isGitHub}}Pull{{else}}Merge{{/if}} Request updates Dockerfiles to use image digests.\n\n{{#if schedule}}\n**Note**: This PR was created on a configured schedule (\"{{schedule}}\"{{#if timezone}} in timezone `{{timezone}}`{{/if}}) and will not receive updates outside those times.\n{{/if}}\n\n{{#each upgrades as |upgrade|}}\n- {{#if repositoryUrl}}[{{upgrade.depName}}]({{upgrade.repositoryUrl}}){{else}}`{{depName}}`{{/if}}: `{{upgrade.newDigest}}`\n{{/each}}\n\n{{#if hasErrors}}\n\n---\n\n### Errors\n\nRenovate encountered some errors when processing your repository, so you are being notified here even if they do not directly apply to this PR.\n\n{{#each errors as |error|}}\n- `{{error.depName}}`: {{error.message}}\n{{/each}}\n{{/if}}\n\n{{#if hasWarnings}}\n\n---\n\n### Warnings\n\nPlease make sure the following warnings are safe to ignore:\n\n{{#each warnings as |warning|}}\n- `{{warning.depName}}`: {{warning.message}}\n{{/each}}\n{{/if}}\n\n---\n\nThis {{#if isGitHub}}PR{{else}}MR{{/if}} has been generated by [Renovate Bot](https://renovateapp.com)."
}
}</pre></td>
<td>`RENOVATE_DOCKER`</td>
<td><td>
</tr>