Renovate 42 (GitHub) JSON Schema

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).

allowCustomCrateRegistries boolean

Set this to true to allow custom crate registries.

Default: false

allowPlugins boolean

Set this to true if repositories are allowed to run install plugins.

Default: false

allowScripts boolean

Set this to true if repositories are allowed to run install scripts.

Default: false

allowShellExecutorForPostUpgradeCommands boolean

Whether to run commands for postUpgradeTasks inside a shell. This has security implications, as it means that they can call out to other commands or access shell variables. It is difficult to craft an allowedCommands regex to restrict this.

Default: true

allowedCommands string[]

A list of regular expressions that decide which commands are allowed in post-upgrade tasks.

Default:

[]

allowedEnv string[]

List of allowed patterns for environment variable names in repository env config.

Default:

[]

allowedHeaders string[]

List of allowed patterns for header names in repository hostRules config.

Default:

[
  "X-*"
]

allowedUnsafeExecutions string[]

List of possibly unsafe executions which are permitted to run. This enables global control over any implicit commands which are run as part of a renovate run. This is similar to allowedCommands but is specifically used to control executions which run automatically, and are not explicitly added in postUpgradeTasks

Default:

[
  "gradleWrapper"
]

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$/"
  ]
}

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

autodiscover boolean

Autodiscover all repositories.

Default: false

autodiscoverFilter array | null

Filter the list of autodiscovered repositories.

Default: null

One of: string[] string[], string string

autodiscoverNamespaces array | null

Filter the list of autodiscovered repositories by namespaces.

Default: null

autodiscoverProjects array | null

Filter the list of autodiscovered repositories by project names.

Default: null

autodiscoverRepoOrder string | null

The order method for autodiscover server side repository search.

Default: null

Values: "asc" "desc"

autodiscoverRepoSort string | null

The sort method for autodiscover server side repository search.

Default: null

Values: "alpha" "created" "created_at" "updated" "updated_at" "size" "id"

autodiscoverTopics array | null

Filter the list of autodiscovered repositories by topics.

Default: null

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.

baseDir string

The base directory for Renovate to store local files, including repository files and cache. If left empty, Renovate will create its own temporary directory to use.

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

bbUseDevelopmentBranch boolean

Deprecated: This configuration option is only intended to be used with 'global' configuration when self-hosting, not used in a repository configuration file. Renovate likely won't use the configuration, and these fields will be removed from the repository configuration documentation in Renovate v43 (https://github.com/renovatebot/renovate/issues/38728)

Use the repository's development branch as the repository's default branch.

Default: false

bicep object

Configuration object for the bicep manager

Default:

{
  "managerFilePatterns": [
    "/\\.bicep$/"
  ]
}

binarySource string

Controls how third-party tools like npm or Gradle are called: directly, via Docker sidecar containers, or via dynamic install.

Default: "install"

Values: "global" "docker" "install" "hermit"

bitbucket-pipelines object

Configuration object for the bitbucket-pipelines manager

Default:

{
  "managerFilePatterns": [
    "/(^|/)\\.?bitbucket-pipelines\\.ya?ml$/"
  ]
}

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 array

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"
}

cacheDir string

The directory where Renovate stores its cache. If left empty, Renovate creates a subdirectory within the baseDir.

cacheHardTtlMinutes integer

Maximum duration in minutes to keep datasource cache entries.

Default: 10080

cachePrivatePackages boolean

Cache private packages in the datasource cache. This is useful for self-hosted setups

Default: false

cacheTtlOverride object

An object that contains cache namespace TTL override values.

Default:

{}

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"
}

checkedBranches string[]

A list of branch names to mark for creation or rebasing as if it was selected in the Dependency Dashboard issue.

Default:

[]

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

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

configFileNames array | null

Deprecated: This configuration option is only intended to be used with 'global' configuration when self-hosting, not used in a repository configuration file. Renovate likely won't use the configuration, and these fields will be removed from the repository configuration documentation in Renovate v43 (https://github.com/renovatebot/renovate/issues/38728)

List of filenames where repository config will be stored.

Default: null

configMigration boolean

Enable this to get config migration PRs when needed.

Default: false

configValidationError boolean

If enabled, config validation errors will be reported as errors instead of warnings, and Renovate will exit with a non-zero exit code.

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 Record<string, string>

Configuration object to define language or manager version constraints.

Default:

{}

constraintsFiltering string

Perform release filtering based on language constraints.

Default: "none"

Values: "none" "strict"

containerbaseDir string

The directory where Renovate stores its containerbase cache. If left empty, Renovate creates a subdirectory within the cacheDir.

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:

{}

customEnvVariables object

Custom environment variables for child processes and sidecar Docker containers.

Default:

{}

customManagers array

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

deleteAdditionalConfigFile boolean

If set to true, Renovate tries to delete the additional self-hosted config file after reading it.

Default: false

deleteConfigFile boolean

If set to true, Renovate tries to delete the self-hosted config file after reading it.

Default: false

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.

detectGlobalManagerConfig boolean

If true, Renovate tries to detect global manager configuration from the file system.

Default: false

detectHostRulesFromEnv boolean

If true, Renovate tries to detect host rules from environment variables.

Default: false

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$/"
  ]
}

dockerChildPrefix string

Change this value to add a prefix to the Renovate Docker sidecar container names and labels.

Default: "renovate_"

dockerCliOptions string

Pass CLI flags to docker run command when binarySource=docker.

dockerMaxPages integer

By default, Renovate fetches up to 20 pages of Docker tags from registries. But you can set your own limit with this config option.

Default: 20

dockerSidecarImage string

Change this value to override the default Renovate sidecar image.

Default: "ghcr.io/renovatebot/base-image:12.31.2"

dockerUser string

Set the UID and GID for Docker-based binaries if you use binarySource=docker.

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$/"
  ]
}

dryRun string | null

If enabled, perform a dry run by logging messages instead of creating/updating/deleting branches and PRs.

Default: null

Values: "extract" "lookup" "full"

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

encryptedWarning string

Warning text to use if encrypted config is found.

endpoint string | null

Custom endpoint to use.

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:

[]

executionTimeout integer

Default execution timeout in minutes for child processes Renovate creates.

Default: 15

expandCodeOwnersGroups boolean

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

Default: false

exposeAllEnv boolean

Set this to true to allow passing of all environment variables to package managers.

Default: false

extends 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.

force object

Any configuration set in this object will force override existing settings.

forceCli boolean

Decides if CLI configuration options are moved to the force config section.

Default: true

forkCreation boolean

Whether to create forks as needed at runtime when running in "fork mode".

Default: true

forkModeDisallowMaintainerEdits boolean

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

Default: false

forkOrg string

The preferred organization to create or find forked repositories, when in fork mode.

forkProcessing string

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

Default: "auto"

Values: "auto" "enabled" "disabled"

forkToken string

Set a personal access token here to enable "fork mode".

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

gitNoVerify string[] | string

Which Git commands will be run with the --no-verify option.

Default:

[
  "commit",
  "push"
]

gitPrivateKey string

PGP key to use for signing Git commits.

gitPrivateKeyPassphrase string

Passphrase for the gitPrivateKey

gitTimeout integer

Configure the timeout with a number of milliseconds to wait for a Git task.

Default: 0

gitUrl string

Overrides the default resolution for Git remote, e.g. to switch GitLab from HTTPS to SSH-based.

Default: "default"

Values: "default" "ssh" "endpoint"

github-actions object

Configuration object for the github-actions manager

Default:

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

githubTokenWarn boolean

Display warnings about GitHub token not being set.

Default: true

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"
}

globalExtends string[]

Configuration presets to use or extend for a self-hosted config.

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"
}

homebrew object

Configuration object for the homebrew manager

Default:

{
  "commitMessageTopic": "Homebrew Formula {{depName}}",
  "managerFilePatterns": [
    "/^Formula/[^/]+[.]rb$/"
  ]
}

hostRules array

Host rules/configuration including credentials.

html object

Configuration object for the html manager

Default:

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

httpCacheTtlDays integer

Maximum duration in days to keep HTTP cache entries.

Default: 90

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

ignorePrAuthor boolean

Set to true to fetch the entire list of PRs instead of only those authored by the Renovate user.

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

includeMirrors boolean

Whether to process repositories that are mirrors. By default, repositories that are mirrors are skipped.

Default: false

includePaths string[]

Include package files only within these defined paths.

Default:

[]

inheritConfig boolean

If true, Renovate will inherit configuration from the inheritConfigFileName file in inheritConfigRepoName.

Default: false

inheritConfigFileName string

Renovate will look for this config file name in the inheritConfigRepoName.

Default: "org-inherited-config.json"

inheritConfigRepoName string

Renovate will look in this repo for the inheritConfigFileName.

Default: "{{parentOrg}}/renovate-config"

inheritConfigStrict boolean

If true, any inheritedConfig fetch error will result in an aborted run.

Default: false

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"
  }
}

logContext string | null

Add a global or per-repo log context to each log entry.

Default: null

logLevelRemap array

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)?$/"
  ],
  "versioning": "maven"
}

maxMajorIncrement integer

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

Default: 500

mergeConfidenceDatasources string[]

If set, Renovate will query the merge-confidence JSON API only for datasources that are part of this list.

Default:

[
  "go",
  "maven",
  "npm",
  "nuget",
  "packagist",
  "pypi",
  "rubygems"
]

mergeConfidenceEndpoint string

If set, Renovate will query this API for Merge Confidence data.

Default: "https://developer.mend.io/"

meteor object

Configuration object for the meteor manager

Default:

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

migratePresets Record<string, string>

Define presets here which have been removed or renamed and should be migrated automatically.

Default:

{}

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": []
}

onboarding boolean

Deprecated: This configuration option is only intended to be used with 'global' configuration when self-hosting, not used in a repository configuration file. Renovate likely won't use the configuration, and these fields will be removed from the repository configuration documentation in Renovate v43 (https://github.com/renovatebot/renovate/issues/38728)

Require a Configuration PR first.

onboardingAutoCloseAge integer | null

Deprecated: This configuration option is only intended to be used with 'global' configuration when self-hosting, not used in a repository configuration file. Renovate likely won't use the configuration, and these fields will be removed from the repository configuration documentation in Renovate v43 (https://github.com/renovatebot/renovate/issues/38728)

Maximum number of days after which Renovate will stop trying to onboard the repository, and will close any existing onboarding PRs

Default: null

onboardingBranch string

Deprecated: This configuration option is only intended to be used with 'global' configuration when self-hosting, not used in a repository configuration file. Renovate likely won't use the configuration, and these fields will be removed from the repository configuration documentation in Renovate v43 (https://github.com/renovatebot/renovate/issues/38728)

Change this value to override the default onboarding branch name.

Default: "renovate/configure"

onboardingCommitMessage string | null

Deprecated: This configuration option is only intended to be used with 'global' configuration when self-hosting, not used in a repository configuration file. Renovate likely won't use the configuration, and these fields will be removed from the repository configuration documentation in Renovate v43 (https://github.com/renovatebot/renovate/issues/38728)

Change this value to override the default onboarding commit message.

Default: null

onboardingConfig object

Deprecated: This configuration option is only intended to be used with 'global' configuration when self-hosting, not used in a repository configuration file. Renovate likely won't use the configuration, and these fields will be removed from the repository configuration documentation in Renovate v43 (https://github.com/renovatebot/renovate/issues/38728)

Configuration to use for onboarding PRs.

Default:

{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json"
}

onboardingConfigFileName string

Deprecated: This configuration option is only intended to be used with 'global' configuration when self-hosting, not used in a repository configuration file. Renovate likely won't use the configuration, and these fields will be removed from the repository configuration documentation in Renovate v43 (https://github.com/renovatebot/renovate/issues/38728)

Change this value to override the default onboarding config file name.

Default: "renovate.json"

onboardingNoDeps string

Deprecated: This configuration option is only intended to be used with 'global' configuration when self-hosting, not used in a repository configuration file. Renovate likely won't use the configuration, and these fields will be removed from the repository configuration documentation in Renovate v43 (https://github.com/renovatebot/renovate/issues/38728)

Onboard the repository even if no dependencies are found.

Default: "auto"

Values: "auto" "enabled" "disabled"

onboardingPrTitle string

Deprecated: This configuration option is only intended to be used with 'global' configuration when self-hosting, not used in a repository configuration file. Renovate likely won't use the configuration, and these fields will be removed from the repository configuration documentation in Renovate v43 (https://github.com/renovatebot/renovate/issues/38728)

Change this value to override the default onboarding PR title.

Default: "Configure Renovate"

onboardingRebaseCheckbox boolean

Set to enable rebase/retry markdown checkbox for onboarding PRs.

Default: false

optimizeForDisabled boolean

Set to true to perform a check for disabled config prior to cloning.

Default: false

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.

password string

Password for authentication.

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": []
}

persistRepoData boolean

If set to true: keep repository data between runs instead of deleting the data.

Default: false

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$/"
  ]
}

platform string

Platform type of repository.

Default: "github"

Values: "azure" "bitbucket" "bitbucket-server" "codecommit" "forgejo" "gerrit" "gitea" "github" "gitlab" "local"

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"
}

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}}}"

prCommitsPerRunLimit integer

Set the maximum number of commits per Renovate run. By default there is no limit.

Default: 0

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 [Renovate Bot](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."
  ]
}

presetCachePersistence boolean

Cache resolved presets in package cache.

Default: false

printConfig boolean

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

Default: false

privateKey string

Server-side private key.

privateKeyOld string

Secondary or old private key to try.

privateKeyPath string

Path to the Server-side private key.

privateKeyPathOld string

Path to the Server-side old private key.

processEnv Record<string, string>

Environment variables to be used in global config only.

Default:

{}

productLinks Record<string, string>

Links which are used in PRs, issues and comments.

Default:

{
  "documentation": "https://docs.renovatebot.com/",
  "help": "https://github.com/renovatebot/renovate/discussions",
  "homepage": "https://github.com/renovatebot/renovate"
}

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"

redisPrefix string

Key prefix for redis cache entries.

redisUrl string

If set, this Redis URL will be used for caching instead of the file system.

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-presets object

Configuration object for the renovate-config-presets 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"

reportPath string | null

Path to where the file should be written. In case of s3 this has to be a full S3 URI.

Default: null

reportType string | null

Set how, or if, reports should be generated.

Default: null

Values: "logging" "file" "s3"

repositories string[]

List of Repositories.

repositoryCache string

This option decides if Renovate uses a JSON cache to speed up extractions.

Default: "disabled"

Values: "disabled" "enabled" "reset"

repositoryCacheType string

Set the type of renovate repository cache if repositoryCache is enabled.

Default: "local"

requireConfig string

Deprecated: This configuration option is only intended to be used with 'global' configuration when self-hosting, not used in a repository configuration file. Renovate likely won't use the configuration, and these fields will be removed from the repository configuration documentation in Renovate v43 (https://github.com/renovatebot/renovate/issues/38728)

Controls Renovate's behavior regarding repository config files such as renovate.json.

Default: "required"

Values: "required" "optional" "ignored"

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
}

s3Endpoint string

If set, Renovate will use this string as the endpoint when creating the AWS S3 client instance.

s3PathStyle boolean

If set, Renovate will enable forcePathStyle when creating the AWS S3 client instance.

Default: 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"
]

secrets Record<string, string>

Object which holds secret name/value pairs.

Default:

{}

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.

token string

Repository Auth Token.

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$/"
  ]
}

unicodeEmoji boolean

Enable or disable Unicode emoji.

Default: true

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"

useCloudMetadataServices boolean

If false, Renovate does not try to access cloud metadata services.

Default: true

userAgent string | null

If set to any string, Renovate will use this as the user-agent it sends with HTTP requests.

Default: null

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."
}

username string

Username for authentication.

variables Record<string, string>

Object which holds variable name/value pairs.

Default:

{}

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$/"
  ]
}

writeDiscoveredRepos string

Writes discovered repositories to a JSON file and then exit.

Renovate

Schema URL

Properties