schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
renovate-schema.json
|
composerIgnorePlatformReqs
|
Configure use of `--ignore-platform-reqs` or `--ignore-platform-req` for the Composer package manager.
|
{"type": "array", "items": {"type": "string"}, "default": []}
|
renovate-schema.json
|
conan
|
Configuration object for the conan manager
|
{"type": "object", "default": {"fileMatch": ["(^|/)conanfile\\.(txt|py)$"], "datasource": "conan", "versioning": "conan", "enabled": false}}
|
renovate-schema.json
|
confidential
|
If enabled, issues created by Renovate are set as confidential.
|
{"type": "boolean", "default": false}
|
renovate-schema.json
|
configMigration
|
Enable this to get config migration PRs when needed.
|
{"type": "boolean", "default": false}
|
renovate-schema.json
|
configWarningReuseIssue
|
Set this to `false` to make Renovate create a new issue for each config warning, instead of reopening or reusing an existing issue.
|
{"type": "boolean", "default": true}
|
renovate-schema.json
|
constraints
|
Configuration object to define language or manager version constraints.
|
{"type": "object", "default": {}}
|
renovate-schema.json
|
constraintsFiltering
|
Perform release filtering based on language constraints.
|
{"type": "string", "enum": ["none", "strict"], "default": "none"}
|
renovate-schema.json
|
containerbaseDir
|
The directory where Renovate stores its containerbase cache. If left empty, Renovate creates a subdirectory within the `cacheDir`.
|
{"type": "string"}
|
renovate-schema.json
|
cpanfile
|
Configuration object for the cpanfile manager
|
{"type": "object", "default": {"fileMatch": ["(^|/)cpanfile$"]}}
|
renovate-schema.json
|
customDatasources
|
Defines custom datasources for usage by managers
|
{"type": "object", "default": {}, "items": {"allOf": [{"type": "object", "properties": {"defaultRegistryUrlTemplate": {"type": "string", "default": ""}, "format": {"type": "string", "enum": ["json", "plain"], "default": "json"}, "transformTemplates": {"type": "array", "items": {"type": "string"}, "default": []}}}]}}
|
renovate-schema.json
|
description
|
A custom description for this configuration object
|
{"type": "string"}
|
renovate-schema.json
|
defaultRegistryUrlTemplate
|
Template for generating a defaultRegistryUrl for custom datasource
|
{"type": "string", "default": ""}
|
renovate-schema.json
|
format
|
Format of the custom datasource
|
{"type": "string", "enum": ["json", "plain"], "default": "json"}
|
renovate-schema.json
|
transformTemplates
|
List of jsonata transformation rules
|
{"type": "array", "items": {"type": "string"}, "default": []}
|
renovate-schema.json
|
customEnvVariables
|
Custom environment variables for child processes and sidecar Docker containers.
|
{"type": "object", "default": {}}
|
renovate-schema.json
|
customizeDashboard
|
Customize sections in the dependency dashboard issue.
|
{"type": "object", "default": {}, "additionalProperties": {"type": "string"}}
|
renovate-schema.json
|
defaultRegistryUrls
|
List of registry URLs to use as the default for a datasource.
|
{"type": "array", "items": {"type": "string"}, "default": null}
|
renovate-schema.json
|
dependencyDashboard
|
Whether to create a "Dependency Dashboard" issue in the repository.
|
{"type": "boolean", "default": false}
|
renovate-schema.json
|
dependencyDashboardApproval
|
Controls if updates need manual approval from the Dependency Dashboard issue before PRs are created.
|
{"type": "boolean", "default": false}
|
renovate-schema.json
|
dependencyDashboardAutoclose
|
Set to `true` to let Renovate close the Dependency Dashboard issue if there are no more updates.
|
{"type": "boolean", "default": false}
|
renovate-schema.json
|
dependencyDashboardFooter
|
Any text added here will be placed last in the Dependency Dashboard issue body, with a divider separator before it.
|
{"type": "string"}
|
renovate-schema.json
|
dependencyDashboardHeader
|
Any text added here will be placed first in the Dependency Dashboard issue body.
|
{"type": "string", "default": "This issue lists Renovate updates and detected dependencies. Read the [Dependency Dashboard](https://docs.renovatebot.com/key-concepts/dashboard/) docs to learn more."}
|
renovate-schema.json
|
dependencyDashboardLabels
|
These labels will always be applied on the Dependency Dashboard issue, even when they have been removed manually.
|
{"type": "array", "items": {"type": "string"}, "default": null}
|
renovate-schema.json
|
dependencyDashboardOSVVulnerabilitySummary
|
Control if the Dependency Dashboard issue lists CVEs supplied by [osv.dev](https://osv.dev).
|
{"type": "string", "enum": ["none", "all", "unresolved"], "default": "none"}
|
renovate-schema.json
|
dependencyDashboardTitle
|
Title for the Dependency Dashboard issue.
|
{"type": "string", "default": "Dependency Dashboard"}
|
renovate-schema.json
|
deps-edn
|
Configuration object for the deps-edn manager
|
{"type": "object", "default": {"fileMatch": ["(^|/)(?:deps|bb)\\.edn$"], "versioning": "maven"}}
|
renovate-schema.json
|
description
|
Plain text description for a config or preset.
|
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
|
renovate-schema.json
|
detectGlobalManagerConfig
|
If `true`, Renovate tries to detect global manager configuration from the file system.
|
{"type": "boolean", "default": false}
|
renovate-schema.json
|
detectHostRulesFromEnv
|
If `true`, Renovate tries to detect host rules from environment variables.
|
{"type": "boolean", "default": false}
|
renovate-schema.json
|
digest
|
Configuration to apply when updating a digest (no change in tag/version).
|
{"type": "object", "default": {"branchTopic": "{{{depNameSanitized}}}-digest", "commitMessageExtra": "to {{newDigestShort}}", "commitMessageTopic": "{{{depName}}} digest"}}
|
renovate-schema.json
|
docker-compose
|
Configuration object for the docker-compose manager
|
{"type": "object", "default": {"fileMatch": ["(^|/)(?:docker-)?compose[^/]*\\.ya?ml$"]}}
|
renovate-schema.json
|
dockerChildPrefix
|
Change this value to add a prefix to the Renovate Docker sidecar container names and labels.
|
{"type": "string", "default": "renovate_"}
|
renovate-schema.json
|
dockerCliOptions
|
Pass CLI flags to `docker run` command when `binarySource=docker`.
|
{"type": "string"}
|
renovate-schema.json
|
dockerSidecarImage
|
Change this value to override the default Renovate sidecar image.
|
{"type": "string", "default": "ghcr.io/containerbase/sidecar:9.17.1"}
|
renovate-schema.json
|
dockerUser
|
Set the `UID` and `GID` for Docker-based binaries if you use `binarySource=docker`.
|
{"type": "string"}
|
renovate-schema.json
|
dockerfile
|
Configuration object for the dockerfile manager
|
{"type": "object", "default": {"fileMatch": ["(^|/|\\.)([Dd]ocker|[Cc]ontainer)file$", "(^|/)([Dd]ocker|[Cc]ontainer)file[^/]*$"]}}
|
renovate-schema.json
|
draftPR
|
If set to `true` then Renovate creates draft PRs, instead of normal status PRs.
|
{"type": "boolean", "default": false}
|
renovate-schema.json
|
droneci
|
Configuration object for the droneci manager
|
{"type": "object", "default": {"fileMatch": ["(^|/)\\.drone\\.yml$"]}}
|
renovate-schema.json
|
dryRun
|
If enabled, perform a dry run by logging messages instead of creating/updating/deleting branches and PRs.
|
{"type": "string", "enum": ["extract", "lookup", "full"], "default": null}
|
renovate-schema.json
|
enabled
|
Enable or disable Renovate bot.
|
{"type": "boolean"}
|
renovate-schema.json
|
enabledManagers
|
A list of package managers to enable. Only managers on the list are enabled.
|
{"type": "array", "items": {"type": "string"}}
|
renovate-schema.json
|
encrypted
|
An object containing configuration encrypted with project key.
|
{"type": "object", "default": null}
|
renovate-schema.json
|
endpoint
|
Custom endpoint to use.
|
{"type": "string", "default": null}
|
renovate-schema.json
|
excludeCommitPaths
|
A file matching any of these glob patterns will not be committed, even if the file has been updated.
|
{"type": "array", "items": {"type": "string"}, "default": []}
|
renovate-schema.json
|
executionTimeout
|
Default execution timeout in minutes for child processes Renovate creates.
|
{"type": "integer", "default": 15}
|
renovate-schema.json
|
exposeAllEnv
|
Set this to `true` to allow passing of all environment variables to package managers.
|
{"type": "boolean", "default": false}
|
renovate-schema.json
|
extends
|
Configuration presets to use or extend.
|
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}
|
renovate-schema.json
|
extractVersion
|
A regex (`re2`) to extract a version from a datasource's raw version string.
|
{"type": "string", "format": "regex"}
|
renovate-schema.json
|
fetchReleaseNotes
|
Controls if and when release notes are fetched.
|
{"type": "string", "enum": ["off", "branch", "pr"], "default": "pr"}
|
renovate-schema.json
|
fileMatch
|
RegEx (`re2`) pattern for matching manager files.
|
{"oneOf": [{"type": "array", "items": {"type": "string", "format": "regex"}}, {"type": "string", "format": "regex"}]}
|
renovate-schema.json
|
filterUnavailableUsers
|
Filter reviewers and assignees based on their availability.
|
{"type": "boolean", "default": false}
|
renovate-schema.json
|
fleet
|
Configuration object for the fleet manager
|
{"type": "object", "default": {"fileMatch": ["(^|/)fleet\\.ya?ml"]}}
|
renovate-schema.json
|
flux
|
Configuration object for the flux manager
|
{"type": "object", "default": {"fileMatch": ["(^|/)flux-system/(?:.+/)?gotk-components\\.ya?ml$"]}}
|
renovate-schema.json
|
followTag
|
If defined, packages will follow this release tag exactly.
|
{"type": "string"}
|
renovate-schema.json
|
force
|
Any configuration set in this object will force override existing settings.
|
{"type": "object"}
|
renovate-schema.json
|
forceCli
|
Decides if CLI configuration options are moved to the `force` config section.
|
{"type": "boolean", "default": true}
|
renovate-schema.json
|
forkModeDisallowMaintainerEdits
|
Disallow maintainers to push to Renovate pull requests when running in fork mode.
|
{"type": "boolean", "default": false}
|
renovate-schema.json
|
forkOrg
|
The preferred organization to create or find forked repositories, when in fork mode.
|
{"type": "string"}
|
renovate-schema.json
|
forkProcessing
|
Whether to process forked repositories. By default, all forked repositories are skipped when in `autodiscover` mode.
|
{"type": "string", "enum": ["auto", "enabled", "disabled"], "default": "auto"}
|
renovate-schema.json
|
forkToken
|
Set a personal access token here to enable "fork mode".
|
{"type": "string"}
|
renovate-schema.json
|
fvm
|
Configuration object for the fvm manager
|
{"type": "object", "default": {"fileMatch": ["(^|/)\\.fvm/fvm_config\\.json$"], "versioning": "semver"}}
|
renovate-schema.json
|
git-submodules
|
Configuration object for the git-submodules manager
|
{"type": "object", "default": {"enabled": false, "versioning": "git", "fileMatch": ["(^|/)\\.gitmodules$"]}}
|
renovate-schema.json
|
gitAuthor
|
Author to use for Git commits. Must conform to [RFC5322](https://datatracker.ietf.org/doc/html/rfc5322).
|
{"type": "string"}
|
renovate-schema.json
|
gitIgnoredAuthors
|
Git authors which are ignored by Renovate. Must conform to [RFC5322](https://datatracker.ietf.org/doc/html/rfc5322).
|
{"type": "array", "items": {"type": "string"}}
|
renovate-schema.json
|
gitLabIgnoreApprovals
|
Ignore approval rules for MRs created by Renovate, which is useful for automerge.
|
{"type": "boolean", "default": false}
|
renovate-schema.json
|
gitNoVerify
|
Which Git commands will be run with the `--no-verify` option.
|
{"oneOf": [{"type": "array", "items": {"type": "string", "enum": ["commit", "push"]}}, {"type": "string", "enum": ["commit", "push"]}], "default": ["commit", "push"]}
|
renovate-schema.json
|
gitPrivateKey
|
PGP key to use for signing Git commits.
|
{"type": "string"}
|
renovate-schema.json
|
gitTimeout
|
Configure the timeout with a number of milliseconds to wait for a Git task.
|
{"type": "integer", "default": 0}
|
renovate-schema.json
|
gitUrl
|
Overrides the default resolution for Git remote, e.g. to switch GitLab from HTTPS to SSH-based.
|
{"type": "string", "enum": ["default", "ssh", "endpoint"], "default": "default"}
|
renovate-schema.json
|
github-actions
|
Configuration object for the github-actions manager
|
{"type": "object", "default": {"fileMatch": ["^(workflow-templates|\\.github/workflows)/[^/]+\\.ya?ml$", "(^|/)action\\.ya?ml$"]}}
|
renovate-schema.json
|
githubTokenWarn
|
Display warnings about GitHub token not being set.
|
{"type": "boolean", "default": true}
|
renovate-schema.json
|
gitlabci
|
Configuration object for the gitlabci manager
|
{"type": "object", "default": {"fileMatch": ["\\.gitlab-ci\\.ya?ml$"]}}
|
renovate-schema.json
|
gitlabci-include
|
Configuration object for the gitlabci-include manager
|
{"type": "object", "default": {"fileMatch": ["\\.gitlab-ci\\.ya?ml$"]}}
|
renovate-schema.json
|
globalExtends
|
Configuration presets to use or extend for a self-hosted config.
|
{"type": "array", "items": {"type": "string"}}
|
renovate-schema.json
|
goGetDirs
|
Directory pattern to run `go get` on
|
{"type": "array", "items": {"type": "string"}, "default": ["./..."]}
|
renovate-schema.json
|
gomod
|
Configuration object for the gomod manager
|
{"type": "object", "default": {"fileMatch": ["(^|/)go\\.mod$"], "pinDigests": false}}
|
renovate-schema.json
|
gradle
|
Configuration object for the gradle manager
|
{"type": "object", "default": {"fileMatch": ["\\.gradle(\\.kts)?$", "(^|/)gradle\\.properties$", "(^|/)gradle/.+\\.toml$", "(^|/)buildSrc/.+\\.kt$", "\\.versions\\.toml$", "(^|/)versions.props$", "(^|/)versions.lock$"], "timeout": 600, "versioning": "gradle"}}
|
renovate-schema.json
|
gradle-wrapper
|
Configuration object for the gradle-wrapper manager
|
{"type": "object", "default": {"fileMatch": ["(^|/)gradle/wrapper/gradle-wrapper\\.properties$"], "versioning": "gradle"}}
|
renovate-schema.json
|
group
|
Config if `groupName` is enabled.
|
{"type": "object", "default": {"branchTopic": "{{{groupSlug}}}", "commitMessageTopic": "{{{groupName}}}"}}
|
renovate-schema.json
|
groupName
|
Human understandable name for the dependency group.
|
{"type": "string", "default": null}
|
renovate-schema.json
|
groupSlug
|
Slug to use for group (e.g. in branch name). Slug is calculated from `groupName` if `null`.
|
{"type": "string", "default": null}
|
renovate-schema.json
|
hashedBranchLength
|
If enabled, branch names will use a hashing function to ensure each branch has that length.
|
{"type": "integer", "default": null}
|
renovate-schema.json
|
helm-requirements
|
Configuration object for the helm-requirements manager
|
{"type": "object", "default": {"registryAliases": {"stable": "https://charts.helm.sh/stable"}, "commitMessageTopic": "helm chart {{depName}}", "fileMatch": ["(^|/)requirements\\.ya?ml$"]}}
|
renovate-schema.json
|
helm-values
|
Configuration object for the helm-values manager
|
{"type": "object", "default": {"commitMessageTopic": "helm values {{depName}}", "fileMatch": ["(^|/)values\\.ya?ml$"], "pinDigests": false}}
|
renovate-schema.json
|
helmfile
|
Configuration object for the helmfile manager
|
{"type": "object", "default": {"registryAliases": {"stable": "https://charts.helm.sh/stable"}, "commitMessageTopic": "helm chart {{depName}}", "fileMatch": ["(^|/)helmfile\\.ya?ml$"]}}
|
renovate-schema.json
|
helmsman
|
Configuration object for the helmsman manager
|
{"type": "object", "default": {"fileMatch": []}}
|
renovate-schema.json
|
helmv3
|
Configuration object for the helmv3 manager
|
{"type": "object", "default": {"registryAliases": {"stable": "https://charts.helm.sh/stable"}, "commitMessageTopic": "helm chart {{depName}}", "fileMatch": ["(^|/)Chart\\.ya?ml$"]}}
|
renovate-schema.json
|
hermit
|
Configuration object for the hermit manager
|
{"type": "object", "default": {"fileMatch": ["(^|/)bin/hermit$"], "excludeCommitPaths": ["**/bin/hermit"], "versioning": "hermit"}}
|
renovate-schema.json
|
homebrew
|
Configuration object for the homebrew manager
|
{"type": "object", "default": {"commitMessageTopic": "Homebrew Formula {{depName}}", "fileMatch": ["^Formula/[^/]+[.]rb$"]}}
|
renovate-schema.json
|
hostRules
|
Host rules/configuration including credentials.
|
{"type": "array", "items": {"allOf": [{"type": "object", "properties": {"abortIgnoreStatusCodes": {"type": "array", "items": {"type": "number"}}, "abortOnError": {"type": "boolean", "default": false}, "artifactAuth": {"type": "array", "items": {"type": "string", "enum": ["composer"]}, "default": null}, "authType": {"type": "string", "default": "Bearer"}, "concurrentRequestLimit": {"type": "integer", "default": null}, "dnsCache": {"type": "boolean", "default": false}, "enableHttp2": {"type": "boolean", "default": false}, "hostType": {"type": "string"}, "insecureRegistry": {"type": "boolean"}, "keepalive": {"type": "boolean", "default": false}, "matchHost": {"type": "string"}, "maxRequestsPerSecond": {"type": "integer", "default": 0}, "timeout": {"type": "integer"}}}]}, "default": [{"timeout": 60000}]}
|
renovate-schema.json
|
description
|
A custom description for this configuration object
|
{"type": "string"}
|
renovate-schema.json
|
abortIgnoreStatusCodes
|
A list of HTTP status codes safe to ignore even when `abortOnError=true`.
|
{"type": "array", "items": {"type": "number"}}
|
renovate-schema.json
|
abortOnError
|
If enabled, Renovate aborts its run when HTTP request errors occur.
|
{"type": "boolean", "default": false}
|
renovate-schema.json
|
artifactAuth
|
A list of package managers to enable artifact auth. Only managers on the list are enabled. All are enabled if `null`
|
{"type": "array", "items": {"type": "string", "enum": ["composer"]}, "default": null}
|
renovate-schema.json
|
authType
|
Authentication type for HTTP header. e.g. `"Bearer"` or `"Basic"`. Use `"Token-Only"` to use only the token without an authorization type.
|
{"type": "string", "default": "Bearer"}
|
renovate-schema.json
|
concurrentRequestLimit
|
Limit concurrent requests per host.
|
{"type": "integer", "default": null}
|
renovate-schema.json
|
dnsCache
|
Enable got DNS cache.
|
{"type": "boolean", "default": false}
|
renovate-schema.json
|
enableHttp2
|
Enable got HTTP/2 support.
|
{"type": "boolean", "default": false}
|
renovate-schema.json
|
hostType
|
hostType for a package rule. Can be a platform name or a datasource name.
|
{"type": "string"}
|
renovate-schema.json
|
insecureRegistry
|
Explicitly turn on insecure Docker registry access (HTTP).
|
{"type": "boolean"}
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.