schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
renovate-schema.json
keepalive
Enable HTTP keepalives for hosts.
{"type": "boolean", "default": false}
renovate-schema.json
matchHost
A domain name, host name or base URL to match against.
{"type": "string"}
renovate-schema.json
maxRequestsPerSecond
Limit requests rate per host.
{"type": "integer", "default": 0}
renovate-schema.json
timeout
Timeout (in milliseconds) for queries to external endpoints.
{"type": "integer"}
renovate-schema.json
html
Configuration object for the html manager
{"type": "object", "default": {"fileMatch": ["\\.html?$"], "versioning": "semver", "digest": {"enabled": false}, "pinDigests": false}}
renovate-schema.json
ignoreDeprecated
Avoid upgrading from a non-deprecated version to a deprecated one.
{"type": "boolean", "default": true}
renovate-schema.json
ignoreDeps
Dependencies to ignore.
{"type": "array", "items": {"type": "string"}}
renovate-schema.json
ignorePaths
Skip any package file whose path matches one of these. Can be a string or glob pattern.
{"type": "array", "items": {"type": "string"}, "default": ["**/node_modules/**", "**/bower_components/**"]}
renovate-schema.json
ignorePlugins
Set this to `true` if `allowPlugins=true` but you wish to skip running plugins when updating lock files.
{"type": "boolean", "default": false}
renovate-schema.json
ignorePrAuthor
Set to `true` to fetch the entire list of PRs instead of only those authored by the Renovate user.
{"type": "boolean", "default": false}
renovate-schema.json
ignorePresets
A list of presets to ignore, including any that are nested inside an `extends` array.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
renovate-schema.json
ignoreReviewers
Reviewers to be ignored in PR reviewers presence (either username or email address depending on the platform).
{"type": "array", "items": {"type": "string"}}
renovate-schema.json
ignoreScripts
Set this to `false` if `allowScripts=true` and you wish to run scripts when updating lock files.
{"type": "boolean", "default": true}
renovate-schema.json
ignoreTests
Set to `true` to enable automerging without tests.
{"type": "boolean", "default": false}
renovate-schema.json
ignoreUnstable
Ignore versions with unstable SemVer.
{"type": "boolean"}
renovate-schema.json
includeMirrors
Whether to process repositories that are mirrors. By default, repositories that are mirrors are skipped.
{"type": "boolean", "default": false}
renovate-schema.json
includePaths
Include package files only within these defined paths.
{"type": "array", "items": {"type": "string"}, "default": []}
renovate-schema.json
internalChecksAsSuccess
Whether to consider passing internal checks such as `minimumReleaseAge` when determining branch status.
{"type": "boolean", "default": false}
renovate-schema.json
internalChecksFilter
When and how to filter based on internal checks.
{"type": "string", "enum": ["strict", "flexible", "none"], "default": "strict"}
renovate-schema.json
jenkins
Configuration object for the jenkins manager
{"type": "object", "default": {"fileMatch": ["(^|/)plugins\\.(txt|ya?ml)$"]}}
renovate-schema.json
jsonnet-bundler
Configuration object for the jsonnet-bundler manager
{"type": "object", "default": {"fileMatch": ["(^|/)jsonnetfile\\.json$"], "datasource": "git-tags"}}
renovate-schema.json
kotlin-script
Configuration object for the kotlin-script manager
{"type": "object", "default": {"fileMatch": ["^.+\\.main\\.kts$"]}}
renovate-schema.json
kubernetes
Configuration object for the kubernetes manager
{"type": "object", "default": {"fileMatch": []}}
renovate-schema.json
kustomize
Configuration object for the kustomize manager
{"type": "object", "default": {"fileMatch": ["(^|/)kustomization\\.ya?ml$"], "pinDigests": false}}
renovate-schema.json
labels
Labels to set in Pull Request.
{"type": "array", "items": {"type": "string"}}
renovate-schema.json
leiningen
Configuration object for the leiningen manager
{"type": "object", "default": {"fileMatch": ["(^|/)project\\.clj$"], "versioning": "maven"}}
renovate-schema.json
lockFileMaintenance
Configuration for lock file maintenance.
{"type": "object", "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"}}}
renovate-schema.json
logContext
Add a global or per-repo log context to each log entry.
{"type": "string", "default": null}
renovate-schema.json
logFile
Log file path.
{"type": "string"}
renovate-schema.json
logFileLevel
Set the log file log level.
{"type": "string", "default": "debug"}
renovate-schema.json
major
Configuration to apply when an update type is `major`.
{"type": "object", "default": {}}
renovate-schema.json
maven
Configuration object for the maven manager
{"type": "object", "default": {"fileMatch": ["(^|/|\\.)pom\\.xml$", "^(((\\.mvn)|(\\.m2))/)?settings\\.xml$"], "versioning": "maven"}}
renovate-schema.json
maven-wrapper
Configuration object for the maven-wrapper manager
{"type": "object", "default": {"fileMatch": ["(^|\\/).mvn/wrapper/maven-wrapper.properties$"], "versioning": "maven"}}
renovate-schema.json
meteor
Configuration object for the meteor manager
{"type": "object", "default": {"fileMatch": ["(^|/)package\\.js$"]}}
renovate-schema.json
migratePresets
Define presets here which have been removed or renamed and should be migrated automatically.
{"type": "object", "default": {}, "additionalProperties": {"type": "string"}}
renovate-schema.json
minimumReleaseAge
Time required before a new release is considered stable.
{"type": "string", "default": null}
renovate-schema.json
minor
Configuration to apply when an update type is `minor`.
{"type": "object", "default": {}}
renovate-schema.json
mint
Configuration object for the mint manager
{"type": "object", "default": {"fileMatch": ["(^|/)Mintfile$"]}}
renovate-schema.json
mix
Configuration object for the mix manager
{"type": "object", "default": {"fileMatch": ["(^|/)mix\\.exs$"], "versioning": "hex"}}
renovate-schema.json
nix
Configuration object for the nix manager
{"type": "object", "default": {"fileMatch": ["(^|/)flake\\.nix$"], "commitMessageTopic": "nixpkgs", "commitMessageExtra": "to {{newValue}}", "enabled": false}}
renovate-schema.json
nodenv
Configuration object for the nodenv manager
{"type": "object", "default": {"fileMatch": ["(^|/)\\.node-version$"], "versioning": "node"}}
renovate-schema.json
npm
Configuration object for the npm manager
{"type": "object", "default": {"fileMatch": ["(^|/)package\\.json$"], "versioning": "npm", "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}})"}}}
renovate-schema.json
npmToken
npm token used to authenticate with the default registry.
{"type": "string"}
renovate-schema.json
npmrc
String copy of `.npmrc` file. Use `\n` instead of line breaks.
{"type": "string"}
renovate-schema.json
npmrcMerge
Whether to merge `config.npmrc` with repo `.npmrc` content if both are found.
{"type": "boolean", "default": false}
renovate-schema.json
nuget
Configuration object for the nuget manager
{"type": "object", "default": {"fileMatch": ["\\.(?:cs|fs|vb)proj$", "\\.(?:props|targets)$", "(^|/)dotnet-tools\\.json$", "(^|/)global\\.json$"]}}
renovate-schema.json
nvm
Configuration object for the nvm manager
{"type": "object", "default": {"fileMatch": ["(^|/)\\.nvmrc$"], "versioning": "node", "pinDigests": false}}
renovate-schema.json
onboarding
Require a Configuration PR first.
{"type": "boolean"}
renovate-schema.json
onboardingBranch
Change this value to override the default onboarding branch name.
{"type": "string", "default": "renovate/configure"}
renovate-schema.json
onboardingCommitMessage
Change this value to override the default onboarding commit message.
{"type": "string", "default": null}
renovate-schema.json
onboardingConfig
Configuration to use for onboarding PRs.
{"type": "object", "default": {"$schema": "https://docs.renovatebot.com/renovate-schema.json"}}
renovate-schema.json
onboardingConfigFileName
Change this value to override the default onboarding config file name.
{"type": "string", "default": "renovate.json"}
renovate-schema.json
onboardingNoDeps
Onboard the repository even if no dependencies are found.
{"type": "boolean", "default": false}
renovate-schema.json
onboardingPrTitle
Change this value to override the default onboarding PR title.
{"type": "string", "default": "Configure Renovate"}
renovate-schema.json
onboardingRebaseCheckbox
Set to enable rebase/retry markdown checkbox for onboarding PRs.
{"type": "boolean", "default": false}
renovate-schema.json
optimizeForDisabled
Set to `true` to perform a check for disabled config prior to cloning.
{"type": "boolean", "default": false}
renovate-schema.json
osgi
Configuration object for the osgi manager
{"type": "object", "default": {"fileMatch": ["(^|/)src/main/features/.+\\.json$"]}}
renovate-schema.json
osvVulnerabilityAlerts
Use vulnerability alerts from `osv.dev`.
{"type": "boolean", "default": false}
renovate-schema.json
packageRules
Rules for matching packages.
{"type": "array", "items": {"allOf": [{"type": "object", "properties": {"allowedVersions": {"type": "string"}, "customChangelogUrl": {"type": "string"}, "excludeDepNames": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "excludeDepPatterns": {"oneOf": [{"type": "array", "items": {"type": "string", "format": "regex"}}, {"type": "string", "format": "regex"}]}, "excludePackageNames": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "excludePackagePatterns": {"oneOf": [{"type": "array", "items": {"type": "string", "format": "regex"}}, {"type": "string", "format": "regex"}]}, "excludePackagePrefixes": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "excludeRepositories": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "matchBaseBranches": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "matchCategories": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "matchConfidence": {"oneOf": [{"type": "array", "items": {"type": "string", "enum": ["low", "neutral", "high", "very high"]}}, {"type": "string", "enum": ["low", "neutral", "high", "very high"]}]}, "matchCurrentValue": {"type": "string"}, "matchCurrentVersion": {"type": "string"}, "matchDatasources": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "matchDepNames": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "matchDepPatterns": {"oneOf": [{"type": "array", "items": {"type": "string", "format": "regex"}}, {"type": "string", "format": "regex"}]}, "matchDepTypes": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "matchFileNames": {"type": "array", "items": {"type": "string"}}, "matchManagers": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "matchPackageNames": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "matchPackagePatterns": {"oneOf": [{"type": "array", "items": {"type": "string", "format": "regex"}}, {"type": "string", "format": "regex"}]}, "matchPackagePrefixes": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "matchRepositories": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "matchSourceUrlPrefixes": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "matchSourceUrls": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "matchUpdateTypes": {"oneOf": [{"type": "array", "items": {"type": "string", "enum": ["major", "minor", "patch", "pin", "pinDigest", "digest", "lockFileMaintenance", "rollback", "bump", "replacement"]}}, {"type": "string", "enum": ["major", "minor", "patch", "pin", "pinDigest", "digest", "lockFileMaintenance", "rollback", "bump", "replacement"]}]}, "replacementName": {"type": "string"}, "replacementNameTemplate": {"type": "string", "default": "{{{packageName}}}"}, "replacementVersion": {"type": "string"}}}]}}
renovate-schema.json
description
A custom description for this configuration object
{"type": "string"}
renovate-schema.json
allowedVersions
A version range or regex pattern capturing allowed versions for dependencies.
{"type": "string"}
renovate-schema.json
customChangelogUrl
If set, Renovate will use this URL to fetch changelogs for a matched dependency. Valid only within a `packageRules` object.
{"type": "string"}
renovate-schema.json
excludeDepNames
Dep names to exclude. Valid only within a `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
renovate-schema.json
excludeDepPatterns
Dep name patterns to exclude. Valid only within a `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string", "format": "regex"}}, {"type": "string", "format": "regex"}]}
renovate-schema.json
excludePackageNames
Package names to exclude. Valid only within a `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
renovate-schema.json
excludePackagePatterns
Package name patterns to exclude. Valid only within a `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string", "format": "regex"}}, {"type": "string", "format": "regex"}]}
renovate-schema.json
excludePackagePrefixes
Package name prefixes to exclude. Valid only within a `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
renovate-schema.json
excludeRepositories
List of repositories to exclude (e.g. `["**/*-archived"]`). Valid only within a `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
renovate-schema.json
matchBaseBranches
List of strings containing exact matches (e.g. `["main"]`) and/or regex expressions (e.g. `["/^release/.*/"]`). Valid only within a `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
renovate-schema.json
matchCategories
List of categories to match (for example: `["python"]`). Valid only within a `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
renovate-schema.json
matchConfidence
Merge confidence levels to match against (`low`, `neutral`, `high`, `very high`). Valid only within `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string", "enum": ["low", "neutral", "high", "very high"]}}, {"type": "string", "enum": ["low", "neutral", "high", "very high"]}]}
renovate-schema.json
matchCurrentValue
A regex to match against the raw `currentValue` string of a dependency. Valid only within a `packageRules` object.
{"type": "string"}
renovate-schema.json
matchCurrentVersion
A version or range of versions to match against the current version of a package. Valid only within a `packageRules` object.
{"type": "string"}
renovate-schema.json
matchDatasources
List of datasources to match (e.g. `["orb"]`). Valid only within a `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
renovate-schema.json
matchDepNames
Dep names to match. Valid only within a `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
renovate-schema.json
matchDepPatterns
Dep name patterns to match. Valid only within a `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string", "format": "regex"}}, {"type": "string", "format": "regex"}]}
renovate-schema.json
matchDepTypes
List of depTypes to match (e.g. [`peerDependencies`]). Valid only within `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
renovate-schema.json
matchFileNames
List of strings to do an exact match against package and lock files with full path. Only works inside a `packageRules` object.
{"type": "array", "items": {"type": "string"}}
renovate-schema.json
matchManagers
List of package managers to match (e.g. `["pipenv"]`). Valid only within a `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
renovate-schema.json
matchPackageNames
Package names to match. Valid only within a `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
renovate-schema.json
matchPackagePatterns
Package name patterns to match. Valid only within a `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string", "format": "regex"}}, {"type": "string", "format": "regex"}]}
renovate-schema.json
matchPackagePrefixes
Package name prefixes to match. Valid only within a `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
renovate-schema.json
matchRepositories
List of repositories to match (e.g. `["**/*-archived"]`). Valid only within a `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
renovate-schema.json
matchSourceUrlPrefixes
A list of source URL prefixes to match against, commonly used to group monorepos or packages from the same organization.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
renovate-schema.json
matchSourceUrls
A list of source URLs to exact match against.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
renovate-schema.json
matchUpdateTypes
Update types to match against (`major`, `minor`, `pin`, `pinDigest`, etc). Valid only within `packageRules` object.
{"oneOf": [{"type": "array", "items": {"type": "string", "enum": ["major", "minor", "patch", "pin", "pinDigest", "digest", "lockFileMaintenance", "rollback", "bump", "replacement"]}}, {"type": "string", "enum": ["major", "minor", "patch", "pin", "pinDigest", "digest", "lockFileMaintenance", "rollback", "bump", "replacement"]}]}
renovate-schema.json
replacementName
The name of the new dependency that replaces the old deprecated dependency.
{"type": "string"}
renovate-schema.json
replacementNameTemplate
Controls what the replacement package name.
{"type": "string", "default": "{{{packageName}}}"}
renovate-schema.json
replacementVersion
The version of the new dependency that replaces the old deprecated dependency.
{"type": "string"}
renovate-schema.json
password
Password for authentication.
{"type": "string"}
renovate-schema.json
patch
Configuration to apply when an update type is `patch`.
{"type": "object", "default": {}}
renovate-schema.json
pep621
Configuration object for the pep621 manager
{"type": "object", "default": {"fileMatch": ["(^|/)pyproject\\.toml$"]}}
renovate-schema.json
persistRepoData
If set to `true`: keep repository data between runs instead of deleting the data.
{"type": "boolean", "default": false}
renovate-schema.json
pin
Configuration to apply when an update type is `pin`.
{"type": "object", "default": {"rebaseWhen": "behind-base-branch", "groupName": "Pin Dependencies", "groupSlug": "pin-dependencies", "commitMessageAction": "Pin", "group": {"commitMessageTopic": "dependencies", "commitMessageExtra": ""}}}
renovate-schema.json
pinDigest
Configuration to apply when pinning a digest (no change in tag/version).
{"type": "object", "default": {"groupName": "Pin Dependencies", "groupSlug": "pin-dependencies", "commitMessageAction": "Pin", "group": {"commitMessageTopic": "dependencies", "commitMessageExtra": ""}}}
renovate-schema.json
pinDigests
Whether to add digests to Dockerfile source images.
{"type": "boolean", "default": false}
renovate-schema.json
pip-compile
Configuration object for the pip-compile manager
{"type": "object", "default": {"fileMatch": [], "lockFileMaintenance": {"enabled": true, "branchTopic": "pip-compile-refresh", "commitMessageAction": "Refresh pip-compile outputs"}}}
renovate-schema.json
pip_requirements
Configuration object for the pip_requirements manager
{"type": "object", "default": {"fileMatch": ["(^|/)[\\w-]*requirements(-\\w+)?\\.(txt|pip)$"]}}
renovate-schema.json
pip_setup
Configuration object for the pip_setup manager
{"type": "object", "default": {"fileMatch": ["(^|/)setup\\.py$"]}}
renovate-schema.json
pipenv
Configuration object for the pipenv manager
{"type": "object", "default": {"fileMatch": ["(^|/)Pipfile$"]}}