mirror of
https://github.com/renovatebot/renovate.git
synced 2025-01-12 06:56:24 +00:00
c3b123a83d
- Renames `packages` to `packageRules` - Refactor `packageName` to `packageNames` array - Refactor `packagePattern` to `packagePatterns` array - Adds `excludePackageNames` array - Adds `excludePackagePatterns` array Closes #529
624 lines
22 KiB
Markdown
624 lines
22 KiB
Markdown
# 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
|
|
|
|
The above are listed in reverse order of preference.
|
|
i.e. `package.json` settings will override `renovate.json` settings, CLI, which overrides env, which overrides the config file, which overrides defaults.
|
|
|
|
### Default Configuration
|
|
|
|
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 = {
|
|
labels: ['upgrade'],
|
|
depTypes: ['dependencies', 'devDependencies'],
|
|
repositories: [
|
|
{
|
|
repository: 'singapore/repo1',
|
|
packageFiles: [
|
|
'package.json',
|
|
{
|
|
packageFile: 'frontend/package.json',
|
|
labels: ['upgrade', 'frontend']
|
|
},
|
|
],
|
|
},
|
|
{
|
|
repository: 'singapore/repo2',
|
|
depTypes: [
|
|
'dependencies',
|
|
'devDependencies',
|
|
{
|
|
depType: 'optionalDependencies',
|
|
labels: ['renovate', 'optional'],
|
|
},
|
|
],
|
|
labels: ['renovate'],
|
|
},
|
|
'singapore/repo3',
|
|
],
|
|
packages: [
|
|
{
|
|
package: 'jquery',
|
|
labels: ['jquery', 'uhoh'],
|
|
},
|
|
],
|
|
}
|
|
```
|
|
|
|
### CLI
|
|
|
|
```
|
|
$ node renovate --help
|
|
|
|
Usage: renovate [options] [repositories...]
|
|
|
|
|
|
Options:
|
|
|
|
--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
|
|
--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
|
|
--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-node-modules [boolean] Skip any package.json files found within node_modules folders
|
|
--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
|
|
--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)
|
|
--pr-creation <string> When to create the PR for a branch. Values: immediate, not-pending, status-success.
|
|
--automerge <string> What types of upgrades to merge to base branch automatically. Values: none, patch, minor or any
|
|
--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)
|
|
-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>`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>`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>`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>`ignoreNodeModules`</td>
|
|
<td>Skip any package.json files found within node_modules folders</td>
|
|
<td>boolean</td>
|
|
<td><pre>true</pre></td>
|
|
<td>`RENOVATE_IGNORE_NODE_MODULES`</td>
|
|
<td>`--ignore-node-modules`<td>
|
|
</tr>
|
|
<tr>
|
|
<td>`dependencies`</td>
|
|
<td>Configuration specifically for `package.json`>`dependencies`</td>
|
|
<td>json</td>
|
|
<td><pre>{}</pre></td>
|
|
<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>
|
|
<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>`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": "renovate/{{depName}}-{{newVersionMajor}}.{{newVersionMinor}}.x"}</pre></td>
|
|
<td>`RENOVATE_PATCH`</td>
|
|
<td><td>
|
|
</tr>
|
|
<tr>
|
|
<td>`semanticCommits`</td>
|
|
<td>Enable semantic commit prefixes for commits and PR titles</td>
|
|
<td>boolean</td>
|
|
<td><pre>false</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><pre>"chore(deps): "</pre></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>`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>`automerge`</td>
|
|
<td>What types of upgrades to merge to base branch automatically. Values: none, patch, minor or any</td>
|
|
<td>string</td>
|
|
<td><pre>"none"</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>"renovate/{{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>"{{semanticPrefix}}Update dependency {{depName}} to version {{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>"{{semanticPrefix}}{{#if isPin}}Pin{{else}}{{#if isRollback}}Roll back{{else}}Update{{/if}}{{/if}} dependency {{depName}} to version {{#if isRange}}{{newVersion}}{{else}}{{#if isMajor}}{{newVersionMajor}}.x{{else}}{{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 version `{{currentVersion}}` to `{{newVersion}}`{{#if isRollback}}. This is necessary and important because version `{{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>`yarnCacheFolder`</td>
|
|
<td>Location of yarn cache folder to use. Set to empty string to disable</td>
|
|
<td>string</td>
|
|
<td><pre>"/tmp/yarn-cache"</pre></td>
|
|
<td>`RENOVATE_YARN_CACHE_FOLDER`</td>
|
|
<td><td>
|
|
</tr>
|
|
<tr>
|
|
<td>`lockFileMaintenance`</td>
|
|
<td>Configuration for lock file maintenance</td>
|
|
<td>json</td>
|
|
<td><pre>{
|
|
"enabled": true,
|
|
"groupName": "Lock File Maintenance",
|
|
"recreateClosed": true,
|
|
"branchName": "renovate/lock-files",
|
|
"commitMessage": "{{semanticPrefix}}Update lock file",
|
|
"prTitle": "{{semanticPrefix}}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"]
|
|
}</pre></td>
|
|
<td>`RENOVATE_LOCK_FILE_MAINTENANCE`</td>
|
|
<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": "renovate/{{groupSlug}}",
|
|
"commitMessage": "{{semanticPrefix}}Renovate {{groupName}} packages",
|
|
"prTitle": "{{semanticPrefix}}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)."
|
|
}</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>
|