Renovate

Renovate configuration file. Documentation: https://docs.renovatebot.com/configuration-options

Type object
File match renovate.json renovate.json5 **/.github/renovate.json **/.github/renovate.json5 **/.gitlab/renovate.json **/.gitlab/renovate.json5 .renovaterc .renovaterc.json .renovaterc.json5
Schema URL https://catalog.lintel.tools/schemas/github/renovate/latest.json
Source https://docs.renovatebot.com/renovate-schema.json

Versions

39 40 41 42

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

abandonmentThreshold string | null

Flags packages that have not been updated within this period as abandoned.

Default: null
addLabels string[]

Labels to add to Pull Request.

additionalBranchPrefix string

Additional string value to be appended to branchPrefix.

Default: ""
additionalReviewers string[]

Additional reviewers for Pull Requests (in contrast to reviewers, this option adds to the existing reviewer list, rather than replacing it).

ansible object

Configuration object for the ansible manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)tasks/[^/]+\\.ya?ml$/"
  ]
}
ansible-galaxy object

Configuration object for the ansible-galaxy manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)(galaxy|requirements)(\\.ansible)?\\.ya?ml$/"
  ]
}
ant object

Configuration object for the ant manager

Default:
{
  "managerFilePatterns": [
    "**/build.xml"
  ]
}
argocd object

Configuration object for the argocd manager

Default:
{
  "managerFilePatterns": []
}
asdf object

Configuration object for the asdf manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)\\.tool-versions$/"
  ]
}
assignAutomerge boolean

Assign reviewers and assignees even if the PR is to be automerged.

Default: false
assignees string[]

Assignees for Pull Request (either username or email address depending on the platform).

assigneesFromCodeOwners boolean

Determine assignees based on configured code owners and changes in PR.

Default: false
assigneesSampleSize integer | null

Take a random sample of given size from assignees.

Default: null
autoApprove boolean

Set to true to automatically approve PRs.

Default: false
autoReplaceGlobalMatch boolean

Control whether replacement regular expressions are global matches or only the first match.

Default: true
automerge boolean

Whether to automerge branches/PRs automatically, without human intervention.

Default: false
automergeComment string

PR comment to add to trigger automerge. Only used if automergeType=pr-comment.

Default: "automergeComment"
automergeSchedule string[] | string

Limit automerge to these times of day or week.

Default:
[
  "at any time"
]
automergeStrategy string

The merge strategy to use when automerging PRs. Used only if automergeType=pr.

Default: "auto"
Values: "auto" "fast-forward" "merge-commit" "rebase" "rebase-merge" "squash"
automergeType string

How to automerge, if enabled.

Default: "pr"
Values: "branch" "pr" "pr-comment"
azure-pipelines object

Configuration object for the azure-pipelines manager

Default:
{
  "managerFilePatterns": [
    "/(^|/).azuredevops/.+\\.ya?ml$/",
    "/azure.*pipelines?.*\\.ya?ml$/"
  ],
  "enabled": false
}
azureWorkItemId integer

The id of an existing work item on Azure Boards to link to each PR.

Default: 0
baseBranchPatterns string[]

List of one or more custom base branches defined as exact strings and/or via regex expressions.

batect object

Configuration object for the batect manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)batect(-bundle)?\\.ya?ml$/"
  ]
}
batect-wrapper object

Configuration object for the batect-wrapper manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)batect$/"
  ],
  "versioning": "semver"
}
bazel object

Configuration object for the bazel manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)WORKSPACE(|\\.bazel|\\.bzlmod)$/",
    "/\\.WORKSPACE\\.bazel$/",
    "/\\.bzl$/"
  ]
}
bazel-module object

Configuration object for the bazel-module manager

Default:
{
  "managerFilePatterns": [
    "/(^|/|\\.)MODULE\\.bazel$/"
  ]
}
bazelisk object

Configuration object for the bazelisk manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)\\.bazelversion$/"
  ],
  "pinDigests": false,
  "versioning": "semver"
}
bbAutoResolvePrTasks boolean

The PR tasks will be automatically completed after the PR is raised.

Default: false
bbUseDefaultReviewers boolean

Use the default reviewers (Bitbucket only).

Default: true
bicep object

Configuration object for the bicep manager

Default:
{
  "managerFilePatterns": [
    "/\\.bicep$/"
  ]
}
bitbucket-pipelines object

Configuration object for the bitbucket-pipelines manager

Default:
{
  "managerFilePatterns": [
    "**/*-pipelines.yml"
  ]
}
bitrise object

Configuration object for the bitrise manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)bitrise\\.ya?ml$/"
  ]
}
branchConcurrentLimit integer | null

Limit to a maximum of x concurrent branches. 0 means no limit, null (default) inherits value from prConcurrentLimit.

Default: null
branchName string

Branch name template.

Default: "{{{branchPrefix}}}{{{additionalBranchPrefix}}}{{{branchTopic}}}"
branchNameStrict boolean

Whether to be strict about the use of special characters within the branch name.

Default: false
branchPrefix string

Prefix to use for all branch names.

Default: "renovate/"
branchPrefixOld string

Old branchPrefix value to check for existing PRs.

Default: "renovate/"
branchTopic string

Branch topic.

Default: "{{{depNameSanitized}}}-{{{newMajor}}}{{#if separateMinorPatch}}{{#if isPatch}}.{{{newMinor}}}{{/if}}{{/if}}{{#if separateMultipleMinor}}{{#if isMinor}}.{{{newMinor}}}{{/if}}{{/if}}.x{{#if isLockfileUpdate}}-lockfile{{/if}}"
buildkite object

Configuration object for the buildkite manager

Default:
{
  "managerFilePatterns": [
    "/buildkite\\.ya?ml/",
    "/\\.buildkite/.+\\.ya?ml$/"
  ],
  "commitMessageTopic": "buildkite plugin {{depName}}",
  "commitMessageExtra": "to {{#if isMajor}}{{{prettyNewMajor}}}{{else}}{{{newValue}}}{{/if}}"
}
buildpacks object

Configuration object for the buildpacks manager

Default:
{
  "commitMessageTopic": "buildpack {{depName}}",
  "managerFilePatterns": [
    "/(^|/)project\\.toml$/"
  ],
  "pinDigests": false
}
bumpVersion string

Bump the version in the package file being updated.

Values: "major" "minor" "patch" "prerelease"
bumpVersions object[]

A list of bumpVersion config options to bump generic version numbers.

Default:
[]
bun object

Configuration object for the bun manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)bun\\.lockb?$/",
    "/(^|/)package\\.json$/"
  ],
  "digest": {
    "prBodyDefinitions": {
      "Change": "{{#if displayFrom}}`{{{displayFrom}}}` → {{else}}{{#if currentValue}}`{{{currentValue}}}` → {{/if}}{{/if}}{{#if displayTo}}`{{{displayTo}}}`{{else}}`{{{newValue}}}`{{/if}}"
    }
  },
  "prBodyDefinitions": {
    "Change": "[{{#if displayFrom}}`{{{displayFrom}}}` → {{else}}{{#if currentValue}}`{{{currentValue}}}` → {{/if}}{{/if}}{{#if displayTo}}`{{{displayTo}}}`{{else}}`{{{newValue}}}`{{/if}}]({{#if depName}}https://renovatebot.com/diffs/npm/{{replace '/' '%2f' depName}}/{{{currentVersion}}}/{{{newVersion}}}{{/if}})"
  }
}
bun-version object

Configuration object for the bun-version manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)\\.bun-version$/"
  ],
  "versioning": "npm"
}
bundler object

Configuration object for the bundler manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)Gemfile$/"
  ],
  "versioning": "ruby"
}
cake object

Configuration object for the cake manager

Default:
{
  "managerFilePatterns": [
    "/\\.cake$/"
  ]
}
cargo object

Configuration object for the cargo manager

Default:
{
  "commitMessageTopic": "Rust crate {{depName}}",
  "managerFilePatterns": [
    "/(^|/)Cargo\\.toml$/"
  ]
}
cdnurl object

Configuration object for the cdnurl manager

Default:
{
  "managerFilePatterns": [],
  "versioning": "semver"
}
circleci object

Configuration object for the circleci manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)\\.circleci/.+\\.ya?ml$/"
  ]
}
cloneSubmodules boolean

Set to true to initialize submodules during repository clone.

Default: false
cloneSubmodulesFilter string[]

List of submodules names or patterns to clone when cloneSubmodules=true.

Default:
[
  "*"
]
cloudbuild object

Configuration object for the cloudbuild manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)cloudbuild\\.ya?ml/"
  ]
}
cocoapods object

Configuration object for the cocoapods manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)Podfile$/"
  ],
  "versioning": "ruby"
}
commitBody string

Commit message body template. Will be appended to commit message, separated by two line returns.

commitBodyTable boolean

If enabled, append a table in the commit message body describing all updates in the commit.

Default: false
commitHourlyLimit integer

Rate limit commits to maximum x per hour. 0 means no limit.

Default: 0
commitMessage string

Message to use for commit messages and pull request titles.

Default: "{{{commitMessagePrefix}}} {{{commitMessageAction}}} {{{commitMessageTopic}}} {{{commitMessageExtra}}} {{{commitMessageSuffix}}}"
commitMessageAction string

Action verb to use in commit messages and PR titles.

Default: "Update"
commitMessageExtra string

Extra description used after the commit message topic - typically the version.

Default: "to {{#if isPinDigest}}{{{newDigestShort}}}{{else}}{{#if isMajor}}{{prettyNewMajor}}{{else}}{{#if isSingleVersion}}{{prettyNewVersion}}{{else}}{{#if newValue}}{{{newValue}}}{{else}}{{{newDigestShort}}}{{/if}}{{/if}}{{/if}}{{/if}}"
commitMessageLowerCase string

Lowercase PR- and commit titles.

Default: "auto"
Values: "auto" "never"
commitMessagePrefix string

Prefix to add to start of commit messages and PR titles. Uses a semantic prefix if semanticCommits is enabled.

commitMessageSuffix string

Suffix to add to end of commit messages and PR titles.

commitMessageTopic string

The upgrade topic/noun used in commit messages and PR titles.

Default: "dependency {{depName}}"
composer object

Configuration object for the composer manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)([\\w-]*)composer\\.json$/"
  ],
  "versioning": "composer"
}
composerIgnorePlatformReqs string[]

Configure use of --ignore-platform-reqs or --ignore-platform-req for the Composer package manager.

Default:
[]
conan object

Configuration object for the conan manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)conanfile\\.(txt|py)$/"
  ],
  "datasource": "conan",
  "versioning": "conan"
}
confidential boolean

If enabled, issues created by Renovate are set as confidential.

Default: false
configMigration boolean

Enable this to get config migration PRs when needed.

Default: false
configWarningReuseIssue boolean

Set this to true to make Renovate reuse/reopen an existing closed Config Warning issue, instead of opening a new one each time.

Default: false
constraints object

Configuration object to define language or manager version constraints.

Default:
{}
54 nested properties
bazelisk string

A constraint for the bazelisk Containerbase tool

bun string

A constraint for the bun Containerbase tool

bundler string

A constraint for the bundler Containerbase tool

cocoapods string

A constraint for the cocoapods Containerbase tool

composer string

A constraint for the composer Containerbase tool

conan string

A constraint for the conan Containerbase tool

copier string

A constraint for the copier Containerbase tool

corepack string

A constraint for the corepack Containerbase tool

deno string

A constraint for the deno Containerbase tool

devbox string

A constraint for the devbox Containerbase tool

dotnet string

A constraint for the dotnet Containerbase tool

erlang string

A constraint for the erlang Containerbase tool

elixir string

A constraint for the elixir Containerbase tool

flux string

A constraint for the flux Containerbase tool

gleam string

A constraint for the gleam Containerbase tool

golang string

A constraint for the golang Containerbase tool

gradle string

A constraint for the gradle Containerbase tool

hashin string

A constraint for the hashin Containerbase tool

helm string

A constraint for the helm Containerbase tool

helmfile string

A constraint for the helmfile Containerbase tool

java string

A constraint for the java Containerbase tool

java-maven string

A constraint for the java-maven Containerbase tool

jb string

A constraint for the jb Containerbase tool

kustomize string

A constraint for the kustomize Containerbase tool

maven string

A constraint for the maven Containerbase tool

nix string

A constraint for the nix Containerbase tool

node string

A constraint for the node Containerbase tool

npm string

A constraint for the npm Containerbase tool

pdm string

A constraint for the pdm Containerbase tool

php string

A constraint for the php Containerbase tool

pip-tools string

A constraint for the pip-tools Containerbase tool

pipenv string

A constraint for the pipenv Containerbase tool

pnpm string

A constraint for the pnpm Containerbase tool

pixi string

A constraint for the pixi Containerbase tool

poetry string

A constraint for the poetry Containerbase tool

python string

A constraint for the python Containerbase tool

ruby string

A constraint for the ruby Containerbase tool. Also used in the rubygems Datasource

rust string

A constraint for the rust Containerbase tool

uv string

A constraint for the uv Containerbase tool

yarn string

A constraint for the yarn Containerbase tool

yarn-slim string

A constraint for the yarn-slim Containerbase tool

dart string

A constraint for the dart Containerbase tool

flutter string

A constraint for the flutter Containerbase tool

vendir string

A constraint for the vendir Containerbase tool

go string

Used in the gomod manager to specify the version of the Go toolchain to use.

In precedence order:

  1. config: constraints.go
  2. go.mod: toolchain directive
  3. go.mod: go directive

NOTE that the constraints.golang is not used (https://github.com/renovatebot/renovate/issues/42601)

gomodMod string

Used in the gomod manager to specify a tag for github.com/marwan-at-work/mod.

Must be prefixed with v.

jenkins string

Used in the jenkins-plugins datasource to specify a minimum version of Jenkins that a plugin must support.

pipTools string

Used in the pip-compile manager to specify a version of pip-tools to use. @deprecated TODO remove in #42599

platform string

Used in the rubygems datasource to specify the platform that the Gem dependency supports.

rubygems string

Used in the rubygems datasource to specify the version of the rubygems tool that is needed to use this Gem.

vscode string

Used in the npm manager to track the version of VSCode that the package is compatible with.

dotnet-sdk string

Used in the nuget manager to track .NET SDK version required.

perl string

Used in the cpanfile manager to track Perl version required.

%goMod string

Used in the gomod manager to determine the minimum version of Go required to use this module.

Note that this is prefixed with a % to explicilty note that this is not a tool that Containerbase knows.

constraintsFiltering string

Perform release filtering based on language constraints.

Default: "none"
Values: "none" "strict"
constraintsVersioning object

Override the versioning scheme used when filtering releases by specific constraint names. Does not apply to tools.

Default:
{}
10 nested properties
go string

Used in the gomod manager to specify the version of the Go toolchain to use.

In precedence order:

  1. config: constraints.go
  2. go.mod: toolchain directive
  3. go.mod: go directive

NOTE that the constraints.golang is not used (https://github.com/renovatebot/renovate/issues/42601)

gomodMod string

Used in the gomod manager to specify a tag for github.com/marwan-at-work/mod.

Must be prefixed with v.

jenkins string

Used in the jenkins-plugins datasource to specify a minimum version of Jenkins that a plugin must support.

pipTools string

Used in the pip-compile manager to specify a version of pip-tools to use. @deprecated TODO remove in #42599

platform string

Used in the rubygems datasource to specify the platform that the Gem dependency supports.

rubygems string

Used in the rubygems datasource to specify the version of the rubygems tool that is needed to use this Gem.

vscode string

Used in the npm manager to track the version of VSCode that the package is compatible with.

dotnet-sdk string

Used in the nuget manager to track .NET SDK version required.

perl string

Used in the cpanfile manager to track Perl version required.

%goMod string

Used in the gomod manager to determine the minimum version of Go required to use this module.

Note that this is prefixed with a % to explicilty note that this is not a tool that Containerbase knows.

copier object

Configuration object for the copier manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)\\.copier-answers(\\..+)?\\.ya?ml/"
  ],
  "versioning": "pep440"
}
cpanfile object

Configuration object for the cpanfile manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)cpanfile$/"
  ]
}
crossplane object

Configuration object for the crossplane manager

Default:
{
  "managerFilePatterns": []
}
crow object

Configuration object for the crow manager

Default:
{
  "managerFilePatterns": [
    "/^\\.crow(?:/[^/]+)?\\.ya?ml$/"
  ]
}
customDatasources object

Defines custom datasources for usage by managers.

Default:
{}
customManagers object[]

Custom managers using regex matching.

Default:
[]
customizeDashboard Record<string, string>

Customize sections in the Dependency Dashboard issue.

Default:
{}
defaultRegistryUrls array | null

List of registry URLs to use as the default for a datasource.

Default: null
deno object

Configuration object for the deno manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)deno\\.lock$/",
    "/(^|/)deno\\.(json|jsonc)$/"
  ],
  "digest": {
    "prBodyDefinitions": {
      "Change": "{{#if displayFrom}}`{{{displayFrom}}}` -> {{else}}{{#if currentValue}}`{{{currentValue}}}` -> {{/if}}{{/if}}{{#if displayTo}}`{{{displayTo}}}`{{else}}`{{{newValue}}}`{{/if}}"
    }
  },
  "prBodyDefinitions": {
    "Change": "{{#if (equals datasource \"npm\")}}[{{#if displayFrom}}`{{{displayFrom}}}` -> {{else}}{{#if currentValue}}`{{{currentValue}}}` -> {{/if}}{{/if}}{{#if displayTo}}`{{{displayTo}}}`{{else}}`{{{newValue}}}`{{/if}}]({{#if depName}}https://renovatebot.com/diffs/npm/{{replace '/' '%2f' depName}}/{{{currentVersion}}}/{{{newVersion}}}{{/if}}){{else}}{{#if displayFrom}}`{{{displayFrom}}}` -> {{else}}{{#if currentValue}}`{{{currentValue}}}` -> {{/if}}{{/if}}{{#if displayTo}}`{{{displayTo}}}`{{else}}`{{{newValue}}}`{{/if}}{{/if}}"
  }
}
dependencyDashboard boolean

Whether to create a "Dependency Dashboard" issue in the repository.

Default: false
dependencyDashboardApproval boolean

Controls if updates need manual approval from the Dependency Dashboard issue before PRs are created.

Default: false
dependencyDashboardAutoclose boolean

Set to true to let Renovate close the Dependency Dashboard issue if there are no more updates.

Default: false
dependencyDashboardCategory string | null

The category to group branches on the Dependency Dashboard issue.

Default: null
dependencyDashboardFooter string

Any text added here will be placed last in the Dependency Dashboard issue body, with a divider separator before it.

dependencyDashboardHeader string

Any text added here will be placed first in the Dependency Dashboard issue body.

Default: "This issue lists Renovate updates and detected dependencies. Read the [Dependency Dashboard](https://docs.renovatebot.com/key-concepts/dashboard/) docs to learn more."
dependencyDashboardLabels array | null

These labels will always be applied on the Dependency Dashboard issue, even when they have been removed manually.

Default: null
dependencyDashboardOSVVulnerabilitySummary string

Control if the Dependency Dashboard issue lists CVEs supplied by osv.dev.

Default: "none"
Values: "none" "all" "unresolved"
dependencyDashboardReportAbandonment boolean

Controls whether abandoned packages are reported in the dependency dashboard.

Default: true
dependencyDashboardTitle string

Title for the Dependency Dashboard issue.

Default: "Dependency Dashboard"
deps-edn object

Configuration object for the deps-edn manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)(?:deps|bb)\\.edn$/"
  ],
  "versioning": "maven"
}
description string[] | string

Plain text description for a config or preset.

devbox object

Configuration object for the devbox manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)devbox\\.json$/"
  ]
}
devcontainer object

Configuration object for the devcontainer manager

Default:
{
  "managerFilePatterns": [
    "/^.devcontainer/devcontainer.json$/",
    "/^.devcontainer.json$/"
  ]
}
digest object

Configuration to apply when updating a digest (no change in tag/version).

Default:
{
  "branchTopic": "{{{depNameSanitized}}}-digest",
  "commitMessageExtra": "to {{newDigestShort}}",
  "commitMessageTopic": "{{{depName}}} digest"
}
docker-compose object

Configuration object for the docker-compose manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)(?:docker-)?compose[^/]*\\.ya?ml$/"
  ]
}
dockerfile object

Configuration object for the dockerfile manager

Default:
{
  "managerFilePatterns": [
    "/(^|/|\\.)([Dd]ocker|[Cc]ontainer)file$/",
    "/(^|/)([Dd]ocker|[Cc]ontainer)file[^/]*$/"
  ]
}
draftPR boolean

If set to true then Renovate creates draft PRs, instead of normal status PRs.

Default: false
droneci object

Configuration object for the droneci manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)\\.drone\\.yml$/"
  ]
}
enabled boolean

Enable or disable corresponding functionality.

Default: true
enabledManagers string[]

A list of package managers to enable. Only managers on the list are enabled.

encrypted object | null

An object containing configuration encrypted with project key.

Default: null
env object

Environment variables that Renovate uses when executing package manager commands.

Default:
{}
excludeCommitPaths string[]

A file matching any of these glob patterns will not be committed, even if the file has been updated.

Default:
[]
expandCodeOwnersGroups boolean

Expand the configured code owner groups into a full list of group members.

Default: false
extends enum | string[] | string

Configuration presets to use or extend.

extractVersion string

A regex (re2) to extract a version from a datasource's raw version string.

format=regex
fetchChangeLogs string

Controls if and when changelogs/release notes are fetched.

Default: "pr"
Values: "off" "branch" "pr"
filterUnavailableUsers boolean

Filter reviewers and assignees based on their availability.

Default: false
fleet object

Configuration object for the fleet manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)fleet\\.ya?ml/"
  ]
}
flux object

Configuration object for the flux manager

Default:
{
  "managerFilePatterns": [
    "/(?:^|/)gotk-components\\.ya?ml$/"
  ]
}
followTag string

If defined, packages will follow this release tag exactly.

forkModeDisallowMaintainerEdits boolean

Disallow maintainers to push to Renovate pull requests when running in fork mode.

Default: false
forkProcessing string

Whether to process forked repositories. By default, all forked repositories are skipped when in autodiscover mode.

Default: "auto"
Values: "auto" "enabled" "disabled"
fvm object

Configuration object for the fvm manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)\\.fvm/fvm_config\\.json$/",
    "/(^|/)\\.fvmrc$/"
  ],
  "versioning": "semver"
}
git-submodules object

Configuration object for the git-submodules manager

Default:
{
  "enabled": false,
  "versioning": "git",
  "managerFilePatterns": [
    "/(^|/)\\.gitmodules$/"
  ]
}
gitAuthor string

Author to use for Git commits. Must conform to RFC5322.

gitIgnoredAuthors string[]

Git authors which are ignored by Renovate. Must conform to RFC5322.

gitLabIgnoreApprovals boolean

Ignore approval rules for MRs created by Renovate, which is useful for automerge.

Default: false
github-actions object

Configuration object for the github-actions manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)(workflow-templates|\\.(?:github|gitea|forgejo)/(?:workflows|actions))/.+\\.ya?ml$/",
    "/(^|/)action\\.ya?ml$/"
  ]
}
gitlabci object

Configuration object for the gitlabci manager

Default:
{
  "managerFilePatterns": [
    "/\\.gitlab-ci\\.ya?ml$/"
  ]
}
gitlabci-include object

Configuration object for the gitlabci-include manager

Default:
{
  "managerFilePatterns": [
    "/\\.gitlab-ci\\.ya?ml$/"
  ]
}
glasskube object

Configuration object for the glasskube manager

Default:
{
  "managerFilePatterns": []
}
gleam object

Configuration object for the gleam manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)gleam.toml$/"
  ],
  "versioning": "hex"
}
goGetDirs string[]

Directory pattern to run go get on.

Default:
[
  "./..."
]
gomod object

Configuration object for the gomod manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)go\\.mod$/"
  ],
  "pinDigests": false
}
gradle object

Configuration object for the gradle manager

Default:
{
  "managerFilePatterns": [
    "/\\.gradle(\\.kts)?$/",
    "/(^|/)gradle\\.properties$/",
    "/(^|/)gradle/.+\\.toml$/",
    "/(^|/)buildSrc/.+\\.kt$/",
    "/\\.versions\\.toml$/",
    "/(^|/)versions.props$/",
    "/(^|/)versions.lock$/"
  ],
  "timeout": 600,
  "versioning": "gradle"
}
gradle-wrapper object

Configuration object for the gradle-wrapper manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)gradle/wrapper/gradle-wrapper\\.properties$/"
  ],
  "versioning": "gradle"
}
group object

Config if groupName is enabled.

Default:
{
  "branchTopic": "{{{groupSlug}}}",
  "commitMessageTopic": "{{{groupName}}}"
}
groupName string | null

Human understandable name for the dependency group.

Default: null
groupSlug string | null

Slug to use for group (e.g. in branch name). Slug is calculated from groupName if null.

Default: null
hashedBranchLength integer | null

If enabled, branch names will use a hashing function to ensure each branch has that length.

Default: null
haskell-cabal object

Configuration object for the haskell-cabal manager

Default:
{
  "managerFilePatterns": [
    "/\\.cabal$/"
  ],
  "pinDigests": false
}
helm-requirements object

Configuration object for the helm-requirements manager

Default:
{
  "registryAliases": {
    "stable": "https://charts.helm.sh/stable"
  },
  "commitMessageTopic": "helm chart {{depName}}",
  "managerFilePatterns": [
    "/(^|/)requirements\\.ya?ml$/"
  ]
}
helm-values object

Configuration object for the helm-values manager

Default:
{
  "commitMessageTopic": "helm values {{depName}}",
  "managerFilePatterns": [
    "/(^|/)values\\.ya?ml$/"
  ],
  "pinDigests": false
}
helmfile object

Configuration object for the helmfile manager

Default:
{
  "registryAliases": {
    "stable": "https://charts.helm.sh/stable"
  },
  "commitMessageTopic": "helm chart {{depName}}",
  "managerFilePatterns": [
    "/(^|/)helmfile\\.ya?ml(?:\\.gotmpl)?$/",
    "/(^|/)helmfile\\.d/.+\\.ya?ml(?:\\.gotmpl)?$/"
  ]
}
helmsman object

Configuration object for the helmsman manager

Default:
{
  "managerFilePatterns": []
}
helmv3 object

Configuration object for the helmv3 manager

Default:
{
  "registryAliases": {
    "stable": "https://charts.helm.sh/stable"
  },
  "commitMessageTopic": "helm chart {{depName}}",
  "managerFilePatterns": [
    "/(^|/)Chart\\.ya?ml$/"
  ]
}
hermit object

Configuration object for the hermit manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)bin/hermit$/"
  ],
  "excludeCommitPaths": [
    "**/bin/hermit"
  ],
  "versioning": "hermit"
}
homeassistant-manifest object

Configuration object for the homeassistant-manifest manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)manifest\\.json$/"
  ]
}
homebrew object

Configuration object for the homebrew manager

Default:
{
  "commitMessageTopic": "Homebrew Formula {{depName}}",
  "managerFilePatterns": [
    "/^Formula/\\w*/?[^/]+[.]rb$/"
  ]
}
hostRules object[]

Host rules/configuration including credentials.

html object

Configuration object for the html manager

Default:
{
  "managerFilePatterns": [
    "/\\.html?$/"
  ],
  "versioning": "semver",
  "digest": {
    "enabled": false
  },
  "pinDigests": false
}
ignoreDeprecated boolean

Avoid upgrading from a non-deprecated version to a deprecated one.

Default: true
ignoreDeps string[]

Dependencies to ignore.

ignorePaths string[]

Skip any package file whose path matches one of these. Can be a string or glob pattern.

Default:
[
  "**/node_modules/**",
  "**/bower_components/**"
]
ignorePlugins boolean

Set this to true if allowPlugins=true but you wish to skip running plugins when updating lock files.

Default: false
ignorePresets string[] | string

A list of presets to ignore, including any that are nested inside an extends array.

ignoreReviewers string[]

Reviewers to be ignored in PR reviewers presence (either username or email address depending on the platform).

ignoreScripts boolean

Set this to false if allowScripts=true and you wish to run scripts when updating lock files.

Default: true
ignoreTests boolean

Set to true to enable automerging without tests.

Default: false
ignoreUnstable boolean

Ignore versions with unstable SemVer.

Default: true
includePaths string[]

Include package files only within these defined paths.

Default:
[]
internalChecksAsSuccess boolean

Whether to consider passing internal checks such as minimumReleaseAge when determining branch status.

Default: false
internalChecksFilter string

When and how to filter based on internal checks.

Default: "strict"
Values: "strict" "flexible" "none"
jenkins object

Configuration object for the jenkins manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)plugins\\.(txt|ya?ml)$/"
  ]
}
jsonata object

Configuration object for the jsonata manager

Default:
{
  "pinDigests": false
}
jsonnet-bundler object

Configuration object for the jsonnet-bundler manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)jsonnetfile\\.json$/"
  ],
  "datasource": "git-tags"
}
keepUpdatedLabel string

If set, users can add this label to PRs to request they be kept updated with the base branch.

kotlin-script object

Configuration object for the kotlin-script manager

Default:
{
  "managerFilePatterns": [
    "/^.+\\.main\\.kts$/"
  ]
}
kubernetes object

Configuration object for the kubernetes manager

Default:
{
  "managerFilePatterns": []
}
kustomize object

Configuration object for the kustomize manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)kustomization\\.ya?ml$/"
  ],
  "pinDigests": false
}
labels string[]

Labels to set in Pull Request.

leiningen object

Configuration object for the leiningen manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)project\\.clj$/"
  ],
  "versioning": "maven"
}
lockFileMaintenance object

Configuration for lock file maintenance.

Default:
{
  "enabled": false,
  "recreateWhen": "always",
  "rebaseStalePrs": true,
  "branchTopic": "lock-file-maintenance",
  "commitMessageAction": "Lock file maintenance",
  "commitMessageTopic": null,
  "commitMessageExtra": null,
  "schedule": [
    "before 4am on monday"
  ],
  "groupName": null,
  "prBodyDefinitions": {
    "Change": "All locks refreshed"
  }
}
logLevelRemap object[]

Remap log levels to different levels.

major object

Configuration to apply when an update type is major.

Default:
{}
maven object

Configuration object for the maven manager

Default:
{
  "managerFilePatterns": [
    "/(^|/|\\.)pom\\.xml$/",
    "/^(((\\.mvn)|(\\.m2))/)?settings\\.xml$/",
    "/(^|/)\\.mvn/extensions\\.xml$/"
  ]
}
maven-wrapper object

Configuration object for the maven-wrapper manager

Default:
{
  "managerFilePatterns": [
    "/(^|\\/).mvn/wrapper/maven-wrapper.properties$/",
    "/(^|\\/)mvnw(.cmd)?$/"
  ]
}
maxMajorIncrement integer

Limit the maximum major version increment allowed. Set to 0 to disable.

Default: 500
meteor object

Configuration object for the meteor manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)package\\.js$/"
  ]
}
milestone integer | null

The number of a milestone. If set, the milestone will be set when Renovate creates the PR.

Default: null
minimumGroupSize integer

The minimum number of updates which must be in a group for branches to be created.

Default: 1
minimumReleaseAge string | null

Time required before a new release is considered stable.

Default: null
minimumReleaseAgeBehaviour string

When set in conjunction with minimumReleaseAge, controls whether the releaseTimestamp for a dependency update is required.

Default: "timestamp-required"
Values: "timestamp-required" "timestamp-optional"
minor object

Configuration to apply when an update type is minor.

Default:
{}
mint object

Configuration object for the mint manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)Mintfile$/"
  ]
}
mise object

Configuration object for the mise manager

Default:
{
  "managerFilePatterns": [
    "**/{,.}mise{,.*}.toml",
    "**/{,.}mise/config{,.*}.toml",
    "**/.config/mise{,.*}.toml",
    "**/.config/mise/{mise,config}{,.*}.toml",
    "**/.config/mise/conf.d/*.toml",
    "**/.rtx{,.*}.toml"
  ]
}
mix object

Configuration object for the mix manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)mix\\.exs$/"
  ]
}
mode string

Mode of operation.

Default: "full"
Values: "full" "silent"
nix object

Configuration object for the nix manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)flake\\.nix$/"
  ],
  "commitMessageTopic": "nix",
  "commitMessageExtra": "to {{newValue}}",
  "enabled": false
}
nodenv object

Configuration object for the nodenv manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)\\.node-version$/"
  ],
  "versioning": "node"
}
npm object

Configuration object for the npm manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)package\\.json$/",
    "/(^|/)pnpm-workspace\\.yaml$/",
    "/(^|/)\\.yarnrc\\.yml$/"
  ],
  "digest": {
    "prBodyDefinitions": {
      "Change": "{{#if displayFrom}}`{{{displayFrom}}}` → {{else}}{{#if currentValue}}`{{{currentValue}}}` → {{/if}}{{/if}}{{#if displayTo}}`{{{displayTo}}}`{{else}}`{{{newValue}}}`{{/if}}"
    }
  },
  "prBodyDefinitions": {
    "Change": "[{{#if displayFrom}}`{{{displayFrom}}}` → {{else}}{{#if currentValue}}`{{{currentValue}}}` → {{/if}}{{/if}}{{#if displayTo}}`{{{displayTo}}}`{{else}}`{{{newValue}}}`{{/if}}]({{#if depName}}https://renovatebot.com/diffs/npm/{{replace '/' '%2f' depName}}/{{{currentVersion}}}/{{{newVersion}}}{{/if}})"
  }
}
npmToken string

npm token used to authenticate with the default registry.

npmrc string

String copy of .npmrc file. Use \n instead of line breaks.

npmrcMerge boolean

Whether to merge config.npmrc with repo .npmrc content if both are found.

Default: false
nuget object

Configuration object for the nuget manager

Default:
{
  "managerFilePatterns": [
    "/\\.(?:cs|fs|vb)proj$/",
    "/\\.(?:props|targets)$/",
    "/(^|/)dotnet-tools\\.json$/",
    "/(^|/)global\\.json$/"
  ]
}
nvm object

Configuration object for the nvm manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)\\.nvmrc$/"
  ],
  "versioning": "node",
  "pinDigests": false
}
ocb object

Configuration object for the ocb manager

Default:
{
  "managerFilePatterns": []
}
osgi object

Configuration object for the osgi manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)src/main/features/.+\\.json$/"
  ]
}
osvVulnerabilityAlerts boolean

Use vulnerability alerts from osv.dev.

Default: false
packageRules array

Rules for matching packages.

patch object

Configuration to apply when an update type is patch.

Default:
{}
pep621 object

Configuration object for the pep621 manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)pyproject\\.toml$/"
  ]
}
pep723 object

Configuration object for the pep723 manager

Default:
{
  "managerFilePatterns": []
}
pin object

Configuration to apply when an update type is pin.

Default:
{
  "rebaseWhen": "behind-base-branch",
  "groupName": "Pin Dependencies",
  "groupSlug": "pin-dependencies",
  "commitMessageAction": "Pin",
  "group": {
    "commitMessageTopic": "dependencies",
    "commitMessageExtra": ""
  }
}
pinDigest object

Configuration to apply when pinning a digest (no change in tag/version).

Default:
{
  "groupName": "Pin Dependencies",
  "groupSlug": "pin-dependencies",
  "commitMessageAction": "Pin",
  "group": {
    "commitMessageTopic": "dependencies",
    "commitMessageExtra": ""
  }
}
pinDigests boolean

Whether to add digests to Dockerfile source images.

Default: false
pip-compile object

Configuration object for the pip-compile manager

Default:
{
  "managerFilePatterns": [],
  "lockFileMaintenance": {
    "enabled": true,
    "branchTopic": "pip-compile-refresh",
    "commitMessageAction": "Refresh pip-compile outputs"
  }
}
pip_requirements object

Configuration object for the pip_requirements manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)[\\w-]*requirements([-._]\\w+)?\\.(txt|pip)$/"
  ]
}
pip_setup object

Configuration object for the pip_setup manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)setup\\.py$/"
  ]
}
pipenv object

Configuration object for the pipenv manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)Pipfile$/"
  ]
}
pixi object

Configuration object for the pixi manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)pyproject\\.toml$/",
    "/(^|/)pixi\\.toml$/"
  ]
}
platformAutomerge boolean

Controls if platform-native auto-merge is used.

Default: true
platformCommit string

Use platform API to perform commits instead of using Git directly.

Default: "auto"
Values: "auto" "disabled" "enabled"
poetry object

Configuration object for the poetry manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)pyproject\\.toml$/"
  ]
}
postUpdateOptions string[]

Enable post-update options to be run after package/artifact updating.

Default:
[]
postUpgradeTasks object

Post-upgrade tasks that are executed before a commit is made by Renovate.

Default:
{
  "commands": [],
  "fileFilters": [],
  "executionMode": "update",
  "installTools": {}
}
prBodyColumns string[]

List of columns to use in PR bodies.

Default:
[
  "Package",
  "Type",
  "Update",
  "Change",
  "Pending"
]
prBodyDefinitions object

Table column definitions to use in PR tables.

Default:
{
  "Package": "{{{depNameLinked}}}{{#if newName}}{{#unless (equals depName newName)}} → {{{newNameLinked}}}{{/unless}}{{/if}}",
  "Type": "{{{depType}}}",
  "Update": "{{{updateType}}}",
  "Current value": "{{{currentValue}}}",
  "New value": "{{{newValue}}}",
  "Change": "`{{{displayFrom}}}` → `{{{displayTo}}}`",
  "Pending": "{{{displayPending}}}",
  "References": "{{{references}}}",
  "Package file": "{{{packageFile}}}",
  "Age": "{{#if newVersion}}![age](https://developer.mend.io/api/mc/badges/age/{{datasource}}/{{replace '/' '%2f' packageName}}/{{{newVersion}}}?slim=true){{/if}}",
  "Adoption": "{{#if newVersion}}![adoption](https://developer.mend.io/api/mc/badges/adoption/{{datasource}}/{{replace '/' '%2f' packageName}}/{{{newVersion}}}?slim=true){{/if}}",
  "Passing": "{{#if newVersion}}![passing](https://developer.mend.io/api/mc/badges/compatibility/{{datasource}}/{{replace '/' '%2f' packageName}}/{{{currentVersion}}}/{{{newVersion}}}?slim=true){{/if}}",
  "Confidence": "{{#if newVersion}}![confidence](https://developer.mend.io/api/mc/badges/confidence/{{datasource}}/{{replace '/' '%2f' packageName}}/{{{currentVersion}}}/{{{newVersion}}}?slim=true){{/if}}"
}
prBodyHeadingDefinitions object

Table header definitions to use in PR tables.

Default:
{
  "Age": "[Age](https://docs.renovatebot.com/merge-confidence/)",
  "Adoption": "[Adoption](https://docs.renovatebot.com/merge-confidence/)",
  "Passing": "[Passing](https://docs.renovatebot.com/merge-confidence/)",
  "Confidence": "[Confidence](https://docs.renovatebot.com/merge-confidence/)"
}
prBodyNotes string[] | string

List of extra notes or templates to include in the Pull Request body.

Default:
[]
prBodyTemplate string

Pull Request body template. Controls which sections are rendered in the body of the pull request.

Default: "{{{header}}}{{{table}}}{{{warnings}}}{{{notes}}}{{{changelogs}}}{{{configDescription}}}{{{controls}}}{{{footer}}}"
prConcurrentLimit integer

Limit to a maximum of x concurrent branches/PRs. 0 means no limit.

Default: 10
prCreation string

When to create the PR for a branch.

Default: "immediate"
Values: "immediate" "not-pending" "status-success" "approval"
prFooter string

Text added here will be placed last in the PR body, with a divider separator before it.

Default: "This PR has been generated by [Mend Renovate](https://github.com/renovatebot/renovate)."
prHeader string

Text added here will be placed first in the PR body.

prHourlyLimit integer

Rate limit PRs to maximum x created per hour. 0 means no limit.

Default: 2
prNotPendingHours integer

Timeout in hours for when prCreation=not-pending.

Default: 25
prTitle string | null

Pull Request title template. Inherits from commitMessage if null.

Default: null
prTitleStrict boolean

Whether to bypass appending extra context to the Pull Request title.

Default: false
pre-commit object

Configuration object for the pre-commit manager

Default:
{
  "commitMessageTopic": "pre-commit hook {{depName}}",
  "enabled": false,
  "managerFilePatterns": [
    "/(^|/)\\.pre-commit-config\\.ya?ml$/"
  ],
  "prBodyNotes": [
    "Note: The `pre-commit` manager in Renovate is not supported by the `pre-commit` maintainers or community. Please do not report any problems there, instead [create a Discussion in the Renovate repository](https://github.com/renovatebot/renovate/discussions/new) if you have any questions."
  ]
}
printConfig boolean

If enabled, Renovate logs the fully resolved config for each repository, plus the fully resolved presets.

Default: false
proto object

Configuration object for the proto manager

Default:
{
  "managerFilePatterns": [
    "**/.prototools"
  ]
}
pruneBranchAfterAutomerge boolean

Set to true to enable branch pruning after automerging.

Default: true
pruneStaleBranches boolean

Set to false to disable pruning stale branches.

Default: true
pub object

Configuration object for the pub manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)pubspec\\.ya?ml$/"
  ]
}
puppet object

Configuration object for the puppet manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)Puppetfile$/"
  ]
}
pyenv object

Configuration object for the pyenv manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)\\.python-version$/"
  ],
  "versioning": "docker",
  "pinDigests": false
}
quadlet object

Configuration object for the quadlet manager

Default:
{
  "managerFilePatterns": [
    "/.+\\.container$/",
    "/.+\\.image$/",
    "/.+\\.volume$/"
  ]
}
rangeStrategy string

Determines how to modify or update existing ranges.

Default: "auto"
Values: "auto" "pin" "bump" "replace" "widen" "update-lockfile" "in-range-only"
rebaseLabel string

Label to request a rebase from Renovate bot.

Default: "rebase"
rebaseWhen string

Controls when Renovate rebases an existing branch.

Default: "auto"
Values: "auto" "never" "conflicted" "behind-base-branch" "automerging"
recreateWhen string

Recreate PRs even if same ones were closed previously.

Default: "auto"
Values: "auto" "always" "never"
regex object

Configuration object for the regex manager

Default:
{
  "pinDigests": false
}
registryAliases Record<string, string>

Aliases for registries.

Default:
{}
registryUrls array | null

List of URLs to try for dependency lookup. Package manager specific.

Default: null
renovate-config object

Configuration object for the renovate-config manager

Default:
{
  "managerFilePatterns": [
    "renovate.json",
    "renovate.json5",
    ".github/renovate.json",
    ".github/renovate.json5",
    ".gitlab/renovate.json",
    ".gitlab/renovate.json5",
    ".renovaterc",
    ".renovaterc.json",
    ".renovaterc.json5"
  ]
}
replacement object

Configuration to apply when replacing a dependency.

Default:
{
  "branchTopic": "{{{depNameSanitized}}}-replacement",
  "commitMessageAction": "Replace",
  "commitMessageExtra": "with {{newName}} {{#if isMajor}}{{{prettyNewMajor}}}{{else}}{{#if isSingleVersion}}{{{prettyNewVersion}}}{{else}}{{{newValue}}}{{/if}}{{/if}}",
  "prBodyNotes": [
    "This is a special PR that replaces `{{{depName}}}` with the community suggested minimal stable replacement version."
  ]
}
replacementApproach string

Select whether to perform a direct replacement or alias replacement.

Default: "replace"
Values: "replace" "alias"
respectLatest boolean

Ignore versions newer than npm "latest" version.

Default: true
reviewers string[]

Requested reviewers for Pull Requests (either username or email address depending on the platform).

reviewersFromCodeOwners boolean

Determine reviewers based on configured code owners and changes in PR.

Default: false
reviewersSampleSize integer | null

Take a random sample of given size from reviewers.

Default: null
rollback object

Configuration to apply when rolling back a version.

Default:
{
  "branchTopic": "{{{depNameSanitized}}}-rollback",
  "commitMessageAction": "Roll back",
  "semanticCommitType": "fix"
}
rollbackPrs boolean

Create PRs to roll back versions if the current version is not found in the registry.

Default: false
ruby-version object

Configuration object for the ruby-version manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)\\.ruby-version$/"
  ],
  "versioning": "ruby"
}
runtime-version object

Configuration object for the runtime-version manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)runtime.txt$/"
  ],
  "pinDigests": false
}
sbt object

Configuration object for the sbt manager

Default:
{
  "managerFilePatterns": [
    "/\\.sbt$/",
    "/project/[^/]*\\.scala$/",
    "/project/build\\.properties$/",
    "/(^|/)repositories$/"
  ],
  "versioning": "ivy"
}
scalafmt object

Configuration object for the scalafmt manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)\\.scalafmt.conf$/"
  ]
}
schedule string[] | string

Limit branch creation to these times of day or week.

Default:
[
  "at any time"
]
semanticCommitScope string

Commit scope to use if Semantic Commits are enabled.

Default: "deps"
semanticCommitType string

Commit type to use if Semantic Commits is enabled.

Default: "chore"
semanticCommits string

Enable Semantic Commit prefixes for commits and PR titles.

Default: "auto"
Values: "auto" "enabled" "disabled"
separateMajorMinor boolean

If set to false, Renovate will upgrade dependencies to their latest release only. Renovate will not separate major or minor branches.

Default: true
separateMinorPatch boolean

If set to true, Renovate will separate minor and patch updates into separate branches.

Default: false
separateMultipleMajor boolean

If set to true, PRs will be raised separately for each available major upgrade version.

Default: false
separateMultipleMinor boolean

If set to true, Renovate creates separate PRs for each minor stream.

Default: false
setup-cfg object

Configuration object for the setup-cfg manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)setup\\.cfg$/"
  ],
  "versioning": "pep440"
}
skipArtifactsUpdate boolean

Skip Renovate's automatic artifact updating.

Default: false
skipInstalls boolean | null

Skip installing modules/dependencies if lock file updating is possible without a full install.

Default: null
statusCheckNames object

Custom strings to use as status check names.

Default:
{
  "artifactError": "renovate/artifacts",
  "configValidation": "renovate/config-validation",
  "mergeConfidence": "renovate/merge-confidence",
  "minimumReleaseAge": "renovate/stability-days"
}
stopUpdatingLabel string

Label to make Renovate stop updating a PR.

Default: "stop-updating"
suppressNotifications string[]

Options to suppress various types of warnings and other notifications.

Default:
[]
sveltos object

Configuration object for the sveltos manager

Default:
{
  "managerFilePatterns": []
}
swift object

Configuration object for the swift manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)Package\\.swift/"
  ],
  "versioning": "swift",
  "pinDigests": false
}
tekton object

Configuration object for the tekton manager

Default:
{
  "managerFilePatterns": []
}
terraform object

Configuration object for the terraform manager

Default:
{
  "commitMessageTopic": "Terraform {{depName}}",
  "managerFilePatterns": [
    "**/*.tf",
    "**/*.tofu"
  ],
  "pinDigests": false
}
terraform-version object

Configuration object for the terraform-version manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)\\.terraform-version$/"
  ],
  "versioning": "hashicorp",
  "extractVersion": "^v(?<version>.*)$"
}
terragrunt object

Configuration object for the terragrunt manager

Default:
{
  "commitMessageTopic": "Terragrunt dependency {{depName}}",
  "managerFilePatterns": [
    "/(^|/)terragrunt\\.hcl$/"
  ]
}
terragrunt-version object

Configuration object for the terragrunt-version manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)\\.terragrunt-version$/"
  ],
  "versioning": "hashicorp",
  "extractVersion": "^v(?<version>.+)$"
}
tflint-plugin object

Configuration object for the tflint-plugin manager

Default:
{
  "commitMessageTopic": "TFLint plugin {{depName}}",
  "managerFilePatterns": [
    "/\\.tflint\\.hcl$/"
  ],
  "extractVersion": "^v(?<version>.*)$"
}
timezone string

Must conform to IANA Time Zone format.

toolSettings object

Tool specific configuration. Global self-hosted configuration takes precedence.

Default:
{
  "jvmMaxMemory": 512,
  "jvmMemory": 512
}
travis object

Configuration object for the travis manager

Default:
{
  "managerFilePatterns": [
    "/^\\.travis\\.ya?ml$/"
  ],
  "major": {
    "enabled": false
  },
  "versioning": "node"
}
typst object

Configuration object for the typst manager

Default:
{
  "managerFilePatterns": [
    "/\\.typ$/"
  ]
}
unity3d object

Configuration object for the unity3d manager

Default:
{
  "managerFilePatterns": [
    "**/ProjectSettings/ProjectVersion.txt"
  ]
}
updateInternalDeps boolean

Whether to update internal dep versions in a monorepo. Works on Yarn Workspaces.

Default: false
updateNotScheduled boolean

Whether to update branches when not scheduled. Renovate will not create branches outside of the schedule.

Default: true
updatePinnedDependencies boolean

Whether to update pinned (single version) dependencies or not.

Default: true
useBaseBranchConfig string

Whether to read configuration from base branches instead of only the default branch.

Default: "none"
Values: "merge" "none"
userStrings object

User-facing strings for the Renovate comment when a PR is closed.

Default:
{
  "ignoreTopic": "Renovate Ignore Notification",
  "ignoreMajor": "Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for *any* future `{{{newMajor}}}.x` releases. But if you manually upgrade to `{{{newMajor}}}.x` then Renovate will re-enable `minor` and `patch` updates automatically.",
  "ignoreDigest": "Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for the `{{{depName}}}` `{{{newDigestShort}}}` update again.",
  "ignoreOther": "Because you closed this PR without merging, Renovate will ignore this update (`{{{newValue}}}`). You will get a PR once a newer version is released. To ignore this dependency forever, add it to the `ignoreDeps` array of your Renovate config.",
  "artifactErrorWarning": "You probably do not want to merge this PR as-is."
}
velaci object

Configuration object for the velaci manager

Default:
{
  "managerFilePatterns": [
    "/(^|/)\\.vela\\.ya?ml$/"
  ]
}
vendir object

Configuration object for the vendir manager

Default:
{
  "commitMessageTopic": "vendir {{depName}}",
  "managerFilePatterns": [
    "/(^|/)vendir\\.yml$/"
  ]
}
versionCompatibility string

A regex (re2) with named capture groups to show how version and compatibility are split from a raw version string.

format=regex
versioning string

Versioning to use for filtering and comparisons.

One of: enum enum, string string
vulnerabilityAlerts object

Config to apply when a PR is needed due to a vulnerability in the existing package version.

Default:
{
  "groupName": null,
  "schedule": [],
  "dependencyDashboardApproval": false,
  "minimumReleaseAge": null,
  "rangeStrategy": "update-lockfile",
  "commitMessageSuffix": "[SECURITY]",
  "branchTopic": "{{{datasource}}}-{{{depNameSanitized}}}-vulnerability",
  "prCreation": "immediate",
  "vulnerabilityFixStrategy": "lowest"
}
woodpecker object

Configuration object for the woodpecker manager

Default:
{
  "managerFilePatterns": [
    "/^\\.woodpecker(?:/[^/]+)?\\.ya?ml$/"
  ]
}
xcodegen object

Configuration object for the xcodegen manager

Default:
{
  "managerFilePatterns": [
    "**/project.yml"
  ],
  "pinDigests": false
}

Definitions

abandonmentThreshold string | null

Flags packages that have not been updated within this period as abandoned.

abortIgnoreStatusCodes number[]

A list of HTTP status codes safe to ignore even when abortOnError=true.

abortOnError boolean

If enabled, Renovate aborts its run when HTTP request errors occur.

addLabels string[]

Labels to add to Pull Request.

additionalBranchPrefix string

Additional string value to be appended to branchPrefix.

additionalReviewers string[]

Additional reviewers for Pull Requests (in contrast to reviewers, this option adds to the existing reviewer list, rather than replacing it).

allowedVersions string

A version range or regex pattern capturing allowed versions for dependencies.

ansible object

Configuration object for the ansible manager

ansible-galaxy object

Configuration object for the ansible-galaxy manager

ant object

Configuration object for the ant manager

argocd object

Configuration object for the argocd manager

artifactAuth array | null

A list of package managers to enable artifact auth. Only managers on the list are enabled. All are enabled if null.

asdf object

Configuration object for the asdf manager

assignAutomerge boolean

Assign reviewers and assignees even if the PR is to be automerged.

assignees string[]

Assignees for Pull Request (either username or email address depending on the platform).

assigneesFromCodeOwners boolean

Determine assignees based on configured code owners and changes in PR.

assigneesSampleSize integer | null

Take a random sample of given size from assignees.

authType string

Authentication type for HTTP header. e.g. "Bearer" or "Basic". Use "Token-Only" to use only the token without an authorization type.

autoApprove boolean

Set to true to automatically approve PRs.

autoReplaceGlobalMatch boolean

Control whether replacement regular expressions are global matches or only the first match.

autoReplaceStringTemplate string

Optional extractVersion for extracted dependencies. Valid only within a customManagers object.

automerge boolean

Whether to automerge branches/PRs automatically, without human intervention.

automergeComment string

PR comment to add to trigger automerge. Only used if automergeType=pr-comment.

automergeSchedule string[] | string

Limit automerge to these times of day or week.

automergeStrategy string

The merge strategy to use when automerging PRs. Used only if automergeType=pr.

automergeType string

How to automerge, if enabled.

azure-pipelines object

Configuration object for the azure-pipelines manager

azureWorkItemId integer

The id of an existing work item on Azure Boards to link to each PR.

baseBranchPatterns string[]

List of one or more custom base branches defined as exact strings and/or via regex expressions.

batect object

Configuration object for the batect manager

batect-wrapper object

Configuration object for the batect-wrapper manager

bazel object

Configuration object for the bazel manager

bazel-module object

Configuration object for the bazel-module manager

bazelisk object

Configuration object for the bazelisk manager

bbAutoResolvePrTasks boolean

The PR tasks will be automatically completed after the PR is raised.

bbUseDefaultReviewers boolean

Use the default reviewers (Bitbucket only).

bicep object

Configuration object for the bicep manager

bitbucket-pipelines object

Configuration object for the bitbucket-pipelines manager

bitrise object

Configuration object for the bitrise manager

branchConcurrentLimit integer | null

Limit to a maximum of x concurrent branches. 0 means no limit, null (default) inherits value from prConcurrentLimit.

branchName string

Branch name template.

branchNameStrict boolean

Whether to be strict about the use of special characters within the branch name.

branchPrefix string

Prefix to use for all branch names.

branchPrefixOld string

Old branchPrefix value to check for existing PRs.

branchTopic string

Branch topic.

buildkite object

Configuration object for the buildkite manager

buildpacks object

Configuration object for the buildpacks manager

bumpType string

The semver level to use when bumping versions. This is used by the bumpVersions feature.

bumpVersion string

Bump the version in the package file being updated.

bumpVersions object[]

A list of bumpVersion config options to bump generic version numbers.

bun object

Configuration object for the bun manager

bun-version object

Configuration object for the bun-version manager

bundler object

Configuration object for the bundler manager

cake object

Configuration object for the cake manager

cargo object

Configuration object for the cargo manager

cdnurl object

Configuration object for the cdnurl manager

changelogUrl string

Set a custom URL for the changelog. Renovate will put this URL in the PR body text.

circleci object

Configuration object for the circleci manager

cloneSubmodules boolean

Set to true to initialize submodules during repository clone.

cloneSubmodulesFilter string[]

List of submodules names or patterns to clone when cloneSubmodules=true.

cloudbuild object

Configuration object for the cloudbuild manager

cocoapods object

Configuration object for the cocoapods manager

commands string[]

A list of post-upgrade commands that are executed before a commit is made by Renovate.

commitBody string

Commit message body template. Will be appended to commit message, separated by two line returns.

commitBodyTable boolean

If enabled, append a table in the commit message body describing all updates in the commit.

commitHourlyLimit integer

Rate limit commits to maximum x per hour. 0 means no limit.

commitMessage string

Message to use for commit messages and pull request titles.

commitMessageAction string

Action verb to use in commit messages and PR titles.

commitMessageExtra string

Extra description used after the commit message topic - typically the version.

commitMessageLowerCase string

Lowercase PR- and commit titles.

commitMessagePrefix string

Prefix to add to start of commit messages and PR titles. Uses a semantic prefix if semanticCommits is enabled.

commitMessageSuffix string

Suffix to add to end of commit messages and PR titles.

commitMessageTopic string

The upgrade topic/noun used in commit messages and PR titles.

composer object

Configuration object for the composer manager

composerIgnorePlatformReqs string[]

Configure use of --ignore-platform-reqs or --ignore-platform-req for the Composer package manager.

conan object

Configuration object for the conan manager

concurrentRequestLimit integer | null

Limit concurrent requests per host.

confidential boolean

If enabled, issues created by Renovate are set as confidential.

configMigration boolean

Enable this to get config migration PRs when needed.

configWarningReuseIssue boolean

Set this to true to make Renovate reuse/reopen an existing closed Config Warning issue, instead of opening a new one each time.

constraints object

Configuration object to define language or manager version constraints.

bazelisk string

A constraint for the bazelisk Containerbase tool

bun string

A constraint for the bun Containerbase tool

bundler string

A constraint for the bundler Containerbase tool

cocoapods string

A constraint for the cocoapods Containerbase tool

composer string

A constraint for the composer Containerbase tool

conan string

A constraint for the conan Containerbase tool

copier string

A constraint for the copier Containerbase tool

corepack string

A constraint for the corepack Containerbase tool

deno string

A constraint for the deno Containerbase tool

devbox string

A constraint for the devbox Containerbase tool

dotnet string

A constraint for the dotnet Containerbase tool

erlang string

A constraint for the erlang Containerbase tool

elixir string

A constraint for the elixir Containerbase tool

flux string

A constraint for the flux Containerbase tool

gleam string

A constraint for the gleam Containerbase tool

golang string

A constraint for the golang Containerbase tool

gradle string

A constraint for the gradle Containerbase tool

hashin string

A constraint for the hashin Containerbase tool

helm string

A constraint for the helm Containerbase tool

helmfile string

A constraint for the helmfile Containerbase tool

java string

A constraint for the java Containerbase tool

java-maven string

A constraint for the java-maven Containerbase tool

jb string

A constraint for the jb Containerbase tool

kustomize string

A constraint for the kustomize Containerbase tool

maven string

A constraint for the maven Containerbase tool

nix string

A constraint for the nix Containerbase tool

node string

A constraint for the node Containerbase tool

npm string

A constraint for the npm Containerbase tool

pdm string

A constraint for the pdm Containerbase tool

php string

A constraint for the php Containerbase tool

pip-tools string

A constraint for the pip-tools Containerbase tool

pipenv string

A constraint for the pipenv Containerbase tool

pnpm string

A constraint for the pnpm Containerbase tool

pixi string

A constraint for the pixi Containerbase tool

poetry string

A constraint for the poetry Containerbase tool

python string

A constraint for the python Containerbase tool

ruby string

A constraint for the ruby Containerbase tool. Also used in the rubygems Datasource

rust string

A constraint for the rust Containerbase tool

uv string

A constraint for the uv Containerbase tool

yarn string

A constraint for the yarn Containerbase tool

yarn-slim string

A constraint for the yarn-slim Containerbase tool

dart string

A constraint for the dart Containerbase tool

flutter string

A constraint for the flutter Containerbase tool

vendir string

A constraint for the vendir Containerbase tool

go string

Used in the gomod manager to specify the version of the Go toolchain to use.

In precedence order:

  1. config: constraints.go
  2. go.mod: toolchain directive
  3. go.mod: go directive

NOTE that the constraints.golang is not used (https://github.com/renovatebot/renovate/issues/42601)

gomodMod string

Used in the gomod manager to specify a tag for github.com/marwan-at-work/mod.

Must be prefixed with v.

jenkins string

Used in the jenkins-plugins datasource to specify a minimum version of Jenkins that a plugin must support.

pipTools string

Used in the pip-compile manager to specify a version of pip-tools to use. @deprecated TODO remove in #42599

platform string

Used in the rubygems datasource to specify the platform that the Gem dependency supports.

rubygems string

Used in the rubygems datasource to specify the version of the rubygems tool that is needed to use this Gem.

vscode string

Used in the npm manager to track the version of VSCode that the package is compatible with.

dotnet-sdk string

Used in the nuget manager to track .NET SDK version required.

perl string

Used in the cpanfile manager to track Perl version required.

%goMod string

Used in the gomod manager to determine the minimum version of Go required to use this module.

Note that this is prefixed with a % to explicilty note that this is not a tool that Containerbase knows.

constraintsFiltering string

Perform release filtering based on language constraints.

constraintsVersioning object

Override the versioning scheme used when filtering releases by specific constraint names. Does not apply to tools.

go string

Used in the gomod manager to specify the version of the Go toolchain to use.

In precedence order:

  1. config: constraints.go
  2. go.mod: toolchain directive
  3. go.mod: go directive

NOTE that the constraints.golang is not used (https://github.com/renovatebot/renovate/issues/42601)

gomodMod string

Used in the gomod manager to specify a tag for github.com/marwan-at-work/mod.

Must be prefixed with v.

jenkins string

Used in the jenkins-plugins datasource to specify a minimum version of Jenkins that a plugin must support.

pipTools string

Used in the pip-compile manager to specify a version of pip-tools to use. @deprecated TODO remove in #42599

platform string

Used in the rubygems datasource to specify the platform that the Gem dependency supports.

rubygems string

Used in the rubygems datasource to specify the version of the rubygems tool that is needed to use this Gem.

vscode string

Used in the npm manager to track the version of VSCode that the package is compatible with.

dotnet-sdk string

Used in the nuget manager to track .NET SDK version required.

perl string

Used in the cpanfile manager to track Perl version required.

%goMod string

Used in the gomod manager to determine the minimum version of Go required to use this module.

Note that this is prefixed with a % to explicilty note that this is not a tool that Containerbase knows.

copier object

Configuration object for the copier manager

cpanfile object

Configuration object for the cpanfile manager

crossplane object

Configuration object for the crossplane manager

crow object

Configuration object for the crow manager

currentValueTemplate string

Optional currentValue for extracted dependencies. Valid only within a customManagers object.

customDatasources object

Defines custom datasources for usage by managers.

customManagers object[]

Custom managers using regex matching.

customType string

Custom manager to use. Valid only within a customManagers object.

customizeDashboard Record<string, string>

Customize sections in the Dependency Dashboard issue.

dataFileTemplate string

A template to create post-upgrade command data file from.

datasourceTemplate string

Optional datasource for extracted dependencies. Valid only within a customManagers object.

defaultRegistryUrlTemplate string

Template for generating a defaultRegistryUrl for custom datasource.

defaultRegistryUrls array | null

List of registry URLs to use as the default for a datasource.

deno object

Configuration object for the deno manager

depNameTemplate string

Optional depName for extracted dependencies. Valid only within a customManagers object.

depTypeTemplate string

Optional depType for extracted dependencies. Valid only within a customManagers object.

dependencyDashboard boolean

Whether to create a "Dependency Dashboard" issue in the repository.

dependencyDashboardApproval boolean

Controls if updates need manual approval from the Dependency Dashboard issue before PRs are created.

dependencyDashboardAutoclose boolean

Set to true to let Renovate close the Dependency Dashboard issue if there are no more updates.

dependencyDashboardCategory string | null

The category to group branches on the Dependency Dashboard issue.

dependencyDashboardFooter string

Any text added here will be placed last in the Dependency Dashboard issue body, with a divider separator before it.

dependencyDashboardHeader string

Any text added here will be placed first in the Dependency Dashboard issue body.

dependencyDashboardLabels array | null

These labels will always be applied on the Dependency Dashboard issue, even when they have been removed manually.

dependencyDashboardOSVVulnerabilitySummary string

Control if the Dependency Dashboard issue lists CVEs supplied by osv.dev.

dependencyDashboardReportAbandonment boolean

Controls whether abandoned packages are reported in the dependency dashboard.

dependencyDashboardTitle string

Title for the Dependency Dashboard issue.

deps-edn object

Configuration object for the deps-edn manager

description string[] | string

Plain text description for a config or preset.

devbox object

Configuration object for the devbox manager

devcontainer object

Configuration object for the devcontainer manager

digest object

Configuration to apply when updating a digest (no change in tag/version).

dnsCache boolean

Enable got DNS cache.

docker-compose object

Configuration object for the docker-compose manager

dockerfile object

Configuration object for the dockerfile manager

draftPR boolean

If set to true then Renovate creates draft PRs, instead of normal status PRs.

droneci object

Configuration object for the droneci manager

enableHttp2 boolean

Enable got HTTP/2 support.

enabled boolean

Enable or disable corresponding functionality.

enabledManagers string[]

A list of package managers to enable. Only managers on the list are enabled.

encrypted object | null

An object containing configuration encrypted with project key.

env object

Environment variables that Renovate uses when executing package manager commands.

excludeCommitPaths string[]

A file matching any of these glob patterns will not be committed, even if the file has been updated.

executionMode string

Controls when the post upgrade tasks run: on every update, or once per upgrade branch.

expandCodeOwnersGroups boolean

Expand the configured code owner groups into a full list of group members.

extends enum | string[] | string

Configuration presets to use or extend.

extractVersion string

A regex (re2) to extract a version from a datasource's raw version string.

extractVersionTemplate string

Optional extractVersion for extracted dependencies. Valid only within a customManagers object.

fetchChangeLogs string

Controls if and when changelogs/release notes are fetched.

fileFilters string[]

Files that match the glob pattern will be committed after running a post-upgrade task.

fileFormat string

It specifies the syntax of the package file being managed by the custom JSONata manager.

filePatterns string[]

A list of patterns to match files that contain the version string.

filterUnavailableUsers boolean

Filter reviewers and assignees based on their availability.

fleet object

Configuration object for the fleet manager

flux object

Configuration object for the flux manager

followTag string

If defined, packages will follow this release tag exactly.

forkModeDisallowMaintainerEdits boolean

Disallow maintainers to push to Renovate pull requests when running in fork mode.

forkProcessing string

Whether to process forked repositories. By default, all forked repositories are skipped when in autodiscover mode.

format string

Format of the custom datasource.

fvm object

Configuration object for the fvm manager

git-submodules object

Configuration object for the git-submodules manager

gitAuthor string

Author to use for Git commits. Must conform to RFC5322.

gitIgnoredAuthors string[]

Git authors which are ignored by Renovate. Must conform to RFC5322.

gitLabIgnoreApprovals boolean

Ignore approval rules for MRs created by Renovate, which is useful for automerge.

github-actions object

Configuration object for the github-actions manager

gitlabci object

Configuration object for the gitlabci manager

gitlabci-include object

Configuration object for the gitlabci-include manager

glasskube object

Configuration object for the glasskube manager

gleam object

Configuration object for the gleam manager

goGetDirs string[]

Directory pattern to run go get on.

gomod object

Configuration object for the gomod manager

gradle object

Configuration object for the gradle manager

gradle-wrapper object

Configuration object for the gradle-wrapper manager

group object

Config if groupName is enabled.

groupName string | null

Human understandable name for the dependency group.

groupSlug string | null

Slug to use for group (e.g. in branch name). Slug is calculated from groupName if null.

hashedBranchLength integer | null

If enabled, branch names will use a hashing function to ensure each branch has that length.

haskell-cabal object

Configuration object for the haskell-cabal manager

headers object

Put fields to be forwarded to the HTTP request headers in the headers config option.

helm-requirements object

Configuration object for the helm-requirements manager

helm-values object

Configuration object for the helm-values manager

helmfile object

Configuration object for the helmfile manager

helmsman object

Configuration object for the helmsman manager

helmv3 object

Configuration object for the helmv3 manager

hermit object

Configuration object for the hermit manager

homeassistant-manifest object

Configuration object for the homeassistant-manifest manager

homebrew object

Configuration object for the homebrew manager

hostRules object[]

Host rules/configuration including credentials.

hostType string

hostType for a package rule. Can be a platform name or a datasource name.

html object

Configuration object for the html manager

httpsCertificate string | null

The certificate chains in PEM format.

httpsCertificateAuthority string | null

The overriding trusted CA certificate.

httpsPrivateKey string | null

The private key in PEM format.

ignoreDeprecated boolean

Avoid upgrading from a non-deprecated version to a deprecated one.

ignoreDeps string[]

Dependencies to ignore.

ignorePaths string[]

Skip any package file whose path matches one of these. Can be a string or glob pattern.

ignorePlugins boolean

Set this to true if allowPlugins=true but you wish to skip running plugins when updating lock files.

ignorePresets string[] | string

A list of presets to ignore, including any that are nested inside an extends array.

ignoreReviewers string[]

Reviewers to be ignored in PR reviewers presence (either username or email address depending on the platform).

ignoreScripts boolean

Set this to false if allowScripts=true and you wish to run scripts when updating lock files.

ignoreTests boolean

Set to true to enable automerging without tests.

ignoreUnstable boolean

Ignore versions with unstable SemVer.

includePaths string[]

Include package files only within these defined paths.

insecureRegistry boolean

Explicitly turn on insecure Docker registry access (HTTP).

installTools object

Install tools before executing commands

bazelisk object

Install the bazelisk Containerbase tool

bun object

Install the bun Containerbase tool

bundler object

Install the bundler Containerbase tool

cocoapods object

Install the cocoapods Containerbase tool

composer object

Install the composer Containerbase tool

conan object

Install the conan Containerbase tool

copier object

Install the copier Containerbase tool

corepack object

Install the corepack Containerbase tool

deno object

Install the deno Containerbase tool

devbox object

Install the devbox Containerbase tool

dotnet object

Install the dotnet Containerbase tool

erlang object

Install the erlang Containerbase tool

elixir object

Install the elixir Containerbase tool

flux object

Install the flux Containerbase tool

gleam object

Install the gleam Containerbase tool

golang object

Install the golang Containerbase tool

gradle object

Install the gradle Containerbase tool

hashin object

Install the hashin Containerbase tool

helm object

Install the helm Containerbase tool

helmfile object

Install the helmfile Containerbase tool

java object

Install the java Containerbase tool

java-maven object

Install the java-maven Containerbase tool

jb object

Install the jb Containerbase tool

kustomize object

Install the kustomize Containerbase tool

maven object

Install the maven Containerbase tool

nix object

Install the nix Containerbase tool

node object

Install the node Containerbase tool

npm object

Install the npm Containerbase tool

pdm object

Install the pdm Containerbase tool

php object

Install the php Containerbase tool

pip-tools object

Install the pip-tools Containerbase tool

pipenv object

Install the pipenv Containerbase tool

pnpm object

Install the pnpm Containerbase tool

pixi object

Install the pixi Containerbase tool

poetry object

Install the poetry Containerbase tool

python object

Install the python Containerbase tool

ruby object

Install the ruby Containerbase tool. Also used in the rubygems Datasource

rust object

Install the rust Containerbase tool

uv object

Install the uv Containerbase tool

yarn object

Install the yarn Containerbase tool

yarn-slim object

Install the yarn-slim Containerbase tool

dart object

Install the dart Containerbase tool

flutter object

Install the flutter Containerbase tool

vendir object

Install the vendir Containerbase tool

internalChecksAsSuccess boolean

Whether to consider passing internal checks such as minimumReleaseAge when determining branch status.

internalChecksFilter string

When and how to filter based on internal checks.

jenkins object

Configuration object for the jenkins manager

jsonata object

Configuration object for the jsonata manager

jsonnet-bundler object

Configuration object for the jsonnet-bundler manager

jvmMaxMemory integer

Maximum JVM memory in MB to use for updates that use a Java VM, like the Gradle Wrapper, defaults to 512. Repo configuration for this value will be ignored if it exceeds the global configuration for toolSettings.jvmMaxMemory

jvmMemory integer

Initial JVM memory in MB to use for updates that use a Java VM, like the Gradle Wrapper, defaults to jvmMaxMemory. Repo configuration for this value will be ignored if it exceeds the global configuration for toolSettings.jvmMaxMemory

keepAlive boolean

Enable HTTP keep-alive for hosts.

keepUpdatedLabel string

If set, users can add this label to PRs to request they be kept updated with the base branch.

kotlin-script object

Configuration object for the kotlin-script manager

kubernetes object

Configuration object for the kubernetes manager

kustomize object

Configuration object for the kustomize manager

labels string[]

Labels to set in Pull Request.

leiningen object

Configuration object for the leiningen manager

lockFileMaintenance object

Configuration for lock file maintenance.

logLevelRemap object[]

Remap log levels to different levels.

major object

Configuration to apply when an update type is major.

managerFilePatterns string[] | string

RegEx (re2) and glob patterns for matching manager files.

matchBaseBranches string[] | string

List of strings containing exact matches (e.g. ["main"]) and/or regex expressions (e.g. ["/^release/.*/"]). Valid only within a packageRules object.

matchCategories string[] | string

List of categories to match (for example: ["python"]). Valid only within a packageRules object.

matchConfidence string[] | string

Merge confidence levels to match against (low, neutral, high, very high). Valid only within packageRules object.

matchCurrentAge string

Matches the current age of the package derived from its release timestamp. Valid only within a packageRules object.

matchCurrentValue string

A regex or glob pattern to match against the raw currentValue string of a dependency. Valid only within a packageRules object.

matchCurrentVersion string

A version, or range of versions, to match against the current version of a package. Valid only within a packageRules object.

matchDatasources string[] | string

List of datasources to match (e.g. ["orb"]). Valid only within a packageRules object.

matchDepNames string[] | string

Dep names to match. Valid only within a packageRules object.

matchDepTypes string[] | string

List of depTypes to match (e.g. [peerDependencies]). Valid only within packageRules object.

matchFileNames string[]

List of strings to do an exact match against package and lock files with full path. Only works inside a packageRules object.

matchHost string

A domain name, host name or base URL to match against.

matchJsonata string[]

A JSONata expression to match against the full config object. Valid only within a packageRules object.

matchManagers string[] | string

List of package managers to match (e.g. ["pipenv"]). Valid only within a packageRules object.

matchMessage string

Regex/minimatch expression to match against log message.

matchNewValue string

A regex or glob pattern to match against the raw newValue string of a dependency. Valid only within a packageRules object.

matchPackageNames string[] | string

Package names to match. Valid only within a packageRules object.

matchRegistryUrls string[] | string

A list of URLs (or URL patterns) to match against registryUrls.

matchRepositories string[] | string

List of repositories to match (e.g. ["**/*-archived"]). Valid only within a packageRules object.

matchSourceUrls string[] | string

A list of exact match URLs (or URL patterns) to match sourceUrl against.

matchStrings string[]

Queries to use. Valid only within bumpVersions or customManagers object.

matchStringsStrategy string

Strategy how to interpret matchStrings.

matchUpdateTypes string[] | string

Update types to match against (major, minor, pin, pinDigest, etc). Valid only within packageRules object.

maven object

Configuration object for the maven manager

maven-wrapper object

Configuration object for the maven-wrapper manager

maxMajorIncrement integer

Limit the maximum major version increment allowed. Set to 0 to disable.

maxRequestsPerSecond integer

Limit requests rate per host.

maxRetryAfter integer

Maximum retry-after header value to wait for before retrying a failed request.

meteor object

Configuration object for the meteor manager

milestone integer | null

The number of a milestone. If set, the milestone will be set when Renovate creates the PR.

minimumGroupSize integer

The minimum number of updates which must be in a group for branches to be created.

minimumReleaseAge string | null

Time required before a new release is considered stable.

minimumReleaseAgeBehaviour string

When set in conjunction with minimumReleaseAge, controls whether the releaseTimestamp for a dependency update is required.

minor object

Configuration to apply when an update type is minor.

mint object

Configuration object for the mint manager

mise object

Configuration object for the mise manager

mix object

Configuration object for the mix manager

mode string

Mode of operation.

name string

A name for the bumpVersion config. This is used for logging and debugging.

newLogLevel string

New log level to use if matchMessage matches.

nix object

Configuration object for the nix manager

nodeMaxMemory integer

Maximum memory in MiB for Node child processes invoked by Renovate. If unset, the Node process will automagically determine the memory limit to use. Repo configuration for this value will be ignored if it exceeds the global configuration for toolSettings.nodeMaxMemory

nodenv object

Configuration object for the nodenv manager

npm object

Configuration object for the npm manager

npmToken string

npm token used to authenticate with the default registry.

npmrc string

String copy of .npmrc file. Use \n instead of line breaks.

npmrcMerge boolean

Whether to merge config.npmrc with repo .npmrc content if both are found.

nuget object

Configuration object for the nuget manager

nvm object

Configuration object for the nvm manager

ocb object

Configuration object for the ocb manager

osgi object

Configuration object for the osgi manager

osvVulnerabilityAlerts boolean

Use vulnerability alerts from osv.dev.

overrideDatasource string

Override the datasource value.

overrideDepName string

Override the depName value.

overridePackageName string

Override the packageName value.

packageNameTemplate string

Optional packageName for extracted dependencies, else defaults to depName value. Valid only within a customManagers object.

packageRules array

Rules for matching packages.

patch object

Configuration to apply when an update type is patch.

pep621 object

Configuration object for the pep621 manager

pep723 object

Configuration object for the pep723 manager

pin object

Configuration to apply when an update type is pin.

pinDigest object

Configuration to apply when pinning a digest (no change in tag/version).

pinDigests boolean

Whether to add digests to Dockerfile source images.

pip-compile object

Configuration object for the pip-compile manager

pip_requirements object

Configuration object for the pip_requirements manager

pip_setup object

Configuration object for the pip_setup manager

pipenv object

Configuration object for the pipenv manager

pixi object

Configuration object for the pixi manager

platformAutomerge boolean

Controls if platform-native auto-merge is used.

platformCommit string

Use platform API to perform commits instead of using Git directly.

poetry object

Configuration object for the poetry manager

postUpdateOptions string[]

Enable post-update options to be run after package/artifact updating.

postUpgradeTasks object

Post-upgrade tasks that are executed before a commit is made by Renovate.

prBodyColumns string[]

List of columns to use in PR bodies.

prBodyDefinitions object

Table column definitions to use in PR tables.

prBodyHeadingDefinitions object

Table header definitions to use in PR tables.

prBodyNotes string[] | string

List of extra notes or templates to include in the Pull Request body.

prBodyTemplate string

Pull Request body template. Controls which sections are rendered in the body of the pull request.

prConcurrentLimit integer

Limit to a maximum of x concurrent branches/PRs. 0 means no limit.

prCreation string

When to create the PR for a branch.

prFooter string

Text added here will be placed last in the PR body, with a divider separator before it.

prHeader string

Text added here will be placed first in the PR body.

prHourlyLimit integer

Rate limit PRs to maximum x created per hour. 0 means no limit.

prNotPendingHours integer

Timeout in hours for when prCreation=not-pending.

prPriority integer

Set sorting priority for PR creation. PRs with higher priority are created first, negative priority last.

prTitle string | null

Pull Request title template. Inherits from commitMessage if null.

prTitleStrict boolean

Whether to bypass appending extra context to the Pull Request title.

pre-commit object

Configuration object for the pre-commit manager

printConfig boolean

If enabled, Renovate logs the fully resolved config for each repository, plus the fully resolved presets.

proto object

Configuration object for the proto manager

pruneBranchAfterAutomerge boolean

Set to true to enable branch pruning after automerging.

pruneStaleBranches boolean

Set to false to disable pruning stale branches.

pub object

Configuration object for the pub manager

puppet object

Configuration object for the puppet manager

pyenv object

Configuration object for the pyenv manager

quadlet object

Configuration object for the quadlet manager

rangeStrategy string

Determines how to modify or update existing ranges.

readOnly boolean

Match against requests that only read data and do not mutate anything.

rebaseLabel string

Label to request a rebase from Renovate bot.

rebaseWhen string

Controls when Renovate rebases an existing branch.

recreateWhen string

Recreate PRs even if same ones were closed previously.

regex object

Configuration object for the regex manager

registryAliases Record<string, string>

Aliases for registries.

registryUrlTemplate string

Optional registry URL for extracted dependencies. Valid only within a customManagers object.

registryUrls array | null

List of URLs to try for dependency lookup. Package manager specific.

renovate-config object

Configuration object for the renovate-config manager

replacement object

Configuration to apply when replacing a dependency.

replacementApproach string

Select whether to perform a direct replacement or alias replacement.

replacementName string

The name of the new dependency that replaces the old deprecated dependency.

replacementNameTemplate string

Controls what the replacement package name.

replacementVersion string

The version of the new dependency that replaces the old deprecated dependency.

replacementVersionTemplate string

Template field for the version of the new dependency that replaces the old deprecated dependency.

respectLatest boolean

Ignore versions newer than npm "latest" version.

reviewers string[]

Requested reviewers for Pull Requests (either username or email address depending on the platform).

reviewersFromCodeOwners boolean

Determine reviewers based on configured code owners and changes in PR.

reviewersSampleSize integer | null

Take a random sample of given size from reviewers.

rollback object

Configuration to apply when rolling back a version.

rollbackPrs boolean

Create PRs to roll back versions if the current version is not found in the registry.

ruby-version object

Configuration object for the ruby-version manager

runtime-version object

Configuration object for the runtime-version manager

sbt object

Configuration object for the sbt manager

scalafmt object

Configuration object for the scalafmt manager

schedule string[] | string

Limit branch creation to these times of day or week.

semanticCommitScope string

Commit scope to use if Semantic Commits are enabled.

semanticCommitType string

Commit type to use if Semantic Commits is enabled.

semanticCommits string

Enable Semantic Commit prefixes for commits and PR titles.

separateMajorMinor boolean

If set to false, Renovate will upgrade dependencies to their latest release only. Renovate will not separate major or minor branches.

separateMinorPatch boolean

If set to true, Renovate will separate minor and patch updates into separate branches.

separateMultipleMajor boolean

If set to true, PRs will be raised separately for each available major upgrade version.

separateMultipleMinor boolean

If set to true, Renovate creates separate PRs for each minor stream.

setup-cfg object

Configuration object for the setup-cfg manager

skipArtifactsUpdate boolean

Skip Renovate's automatic artifact updating.

skipInstalls boolean | null

Skip installing modules/dependencies if lock file updating is possible without a full install.

sourceDirectory string

The source directory in which the package is present at its source.

sourceUrl string

The source URL of the package.

statusCheckNames object

Custom strings to use as status check names.

stopUpdatingLabel string

Label to make Renovate stop updating a PR.

suppressNotifications string[]

Options to suppress various types of warnings and other notifications.

sveltos object

Configuration object for the sveltos manager

swift object

Configuration object for the swift manager

tekton object

Configuration object for the tekton manager

terraform object

Configuration object for the terraform manager

terraform-version object

Configuration object for the terraform-version manager

terragrunt object

Configuration object for the terragrunt manager

terragrunt-version object

Configuration object for the terragrunt-version manager

tflint-plugin object

Configuration object for the tflint-plugin manager

timeout integer

Timeout (in milliseconds) for queries to external endpoints.

timezone string

Must conform to IANA Time Zone format.

toolSettings object

Tool specific configuration. Global self-hosted configuration takes precedence.

transformTemplates string[]

List of jsonata transformation rules.

travis object

Configuration object for the travis manager

typst object

Configuration object for the typst manager

unity3d object

Configuration object for the unity3d manager

updateInternalDeps boolean

Whether to update internal dep versions in a monorepo. Works on Yarn Workspaces.

updateNotScheduled boolean

Whether to update branches when not scheduled. Renovate will not create branches outside of the schedule.

updatePinnedDependencies boolean

Whether to update pinned (single version) dependencies or not.

useBaseBranchConfig string

Whether to read configuration from base branches instead of only the default branch.

userStrings object

User-facing strings for the Renovate comment when a PR is closed.

velaci object

Configuration object for the velaci manager

vendir object

Configuration object for the vendir manager

versionCompatibility string

A regex (re2) with named capture groups to show how version and compatibility are split from a raw version string.

versioning string

Versioning to use for filtering and comparisons.

versioningTemplate string

Optional versioning for extracted dependencies. Valid only within a customManagers object.

vulnerabilityAlerts object

Config to apply when a PR is needed due to a vulnerability in the existing package version.

vulnerabilityFixStrategy string

Strategy to use when fixing vulnerabilities. lowest will propose the earliest version with a fix, highest will always pick the latest version.

woodpecker object

Configuration object for the woodpecker manager

workingDirTemplate string

A template describing the working directory in which post-upgrade tasks should be executed.

xcodegen object

Configuration object for the xcodegen manager