schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
renovate-schema.json | platform | Platform type of repository. | {"type": "string", "enum": ["azure", "bitbucket", "bitbucket-server", "codecommit", "gitea", "github", "gitlab", "local"], "default": "github"} |
renovate-schema.json | platformAutomerge | Controls if platform-native auto-merge is used. | {"type": "boolean", "default": true} |
renovate-schema.json | platformCommit | Use platform API to perform commits instead of using Git directly. | {"type": "boolean", "default": false} |
renovate-schema.json | poetry | Configuration object for the poetry manager | {"type": "object", "default": {"fileMatch": ["(^|/)pyproject\\.toml$"]}} |
renovate-schema.json | postUpdateOptions | Enable post-update options to be run after package/artifact updating. | {"type": "array", "items": {"type": "string", "enum": ["bundlerConservative", "gomodMassage", "gomodTidy", "gomodTidy1.17", "gomodTidyE", "gomodUpdateImportPaths", "helmUpdateSubChartArchives", "npmDedupe", "pnpmDedupe", "yarnDedupeFewer", "yarnDedupeHighest"]}, "default": []} |
renovate-schema.json | postUpgradeTasks | Post-upgrade tasks that are executed before a commit is made by Renovate. | {"type": "object", "default": {"commands": [], "fileFilters": [], "executionMode": "update"}, "items": {"allOf": [{"type": "object", "properties": {"commands": {"type": "array", "items": {"type": "string"}, "default": []}, "executionMode": {"type": "string", "enum": ["update", "branch"], "default": "update"}, "fileFilters": {"type": "array", "items": {"type": "string"}, "default": ["**/*"]}}}]}} |
renovate-schema.json | description | A custom description for this configuration object | {"type": "string"} |
renovate-schema.json | commands | A list of post-upgrade commands that are executed before a commit is made by Renovate. | {"type": "array", "items": {"type": "string"}, "default": []} |
renovate-schema.json | executionMode | Controls when the post upgrade tasks run: on every update, or once per upgrade branch. | {"type": "string", "enum": ["update", "branch"], "default": "update"} |
renovate-schema.json | fileFilters | Files that match the glob pattern will be committed after running a post-upgrade task. | {"type": "array", "items": {"type": "string"}, "default": ["**/*"]} |
renovate-schema.json | prBodyColumns | List of columns to use in PR bodies. | {"type": "array", "items": {"type": "string"}, "default": ["Package", "Type", "Update", "Change", "Pending"]} |
renovate-schema.json | prBodyDefinitions | Table column definitions to use in PR tables. | {"type": "object", "default": {"Package": "{{{depNameLinked}}}", "Type": "{{{depType}}}", "Update": "{{{updateType}}}", "Current value": "{{{currentValue}}}", "New value": "{{{newValue}}}", "Change": "`{{{displayFrom}}}` -> `{{{displayTo}}}`", "Pending": "{{{displayPending}}}", "References": "{{{references}}}", "Package file": "{{{packageFile}}}", "Age": "[](https://docs.renovatebot.com/merge-confidence/)", "Adoption": "[](https://docs.renovatebot.com/merge-confidence/)", "Passing": "[](https://docs.renovatebot.com/merge-confidence/)", "Confidence": "[](https://docs.renovatebot.com/merge-confidence/)"}} |
renovate-schema.json | prBodyNotes | List of extra notes or templates to include in the Pull Request body. | {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}], "default": []} |
renovate-schema.json | prBodyTemplate | Pull Request body template. Controls which sections are rendered in the body of the pull request. | {"type": "string", "default": "{{{header}}}{{{table}}}{{{warnings}}}{{{notes}}}{{{changelogs}}}{{{configDescription}}}{{{controls}}}{{{footer}}}"} |
renovate-schema.json | prCommitsPerRunLimit | Set the maximum number of commits per Renovate run. By default there is no limit. | {"type": "integer", "default": 0} |
renovate-schema.json | prConcurrentLimit | Limit to a maximum of x concurrent branches/PRs. 0 means no limit. | {"type": "integer", "default": 10} |
renovate-schema.json | prCreation | When to create the PR for a branch. | {"type": "string", "enum": ["immediate", "not-pending", "status-success", "approval"], "default": "immediate"} |
renovate-schema.json | prFooter | Text added here will be placed last in the PR body, with a divider separator before it. | {"type": "string", "default": "This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate)."} |
renovate-schema.json | prHeader | Text added here will be placed first in the PR body. | {"type": "string"} |
renovate-schema.json | prHourlyLimit | Rate limit PRs to maximum x created per hour. 0 means no limit. | {"type": "integer", "default": 2} |
renovate-schema.json | prNotPendingHours | Timeout in hours for when `prCreation=not-pending`. | {"type": "integer", "default": 25} |
renovate-schema.json | prPriority | Set sorting priority for PR creation. PRs with higher priority are created first, negative priority last. | {"type": "integer", "default": 0} |
renovate-schema.json | prTitle | Pull Request title template (deprecated). Inherits from `commitMessage` if null. | {"type": "string", "default": null} |
renovate-schema.json | prTitleStrict | Whether to bypass appending extra context to the Pull Request title. | {"type": "boolean", "default": false} |
renovate-schema.json | pre-commit | Configuration object for the pre-commit manager | {"type": "object", "default": {"commitMessageTopic": "pre-commit hook {{depName}}", "enabled": false, "fileMatch": ["(^|/)\\.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."]}} |
renovate-schema.json | printConfig | If enabled, Renovate logs the fully resolved config for each repository, plus the fully resolved presets. | {"type": "boolean", "default": false} |
renovate-schema.json | privateKey | Server-side private key. | {"type": "string"} |
renovate-schema.json | privateKeyOld | Secondary or old private key to try. | {"type": "string"} |
renovate-schema.json | privateKeyPath | Path to the Server-side private key. | {"type": "string"} |
renovate-schema.json | privateKeyPathOld | Path to the Server-side old private key. | {"type": "string"} |
renovate-schema.json | productLinks | Links which are used in PRs, issues and comments. | {"type": "object", "default": {"documentation": "https://docs.renovatebot.com/", "help": "https://github.com/renovatebot/renovate/discussions", "homepage": "https://github.com/renovatebot/renovate"}, "additionalProperties": {"type": "string", "format": "uri"}} |
renovate-schema.json | pruneBranchAfterAutomerge | Set to `true` to enable branch pruning after automerging. | {"type": "boolean", "default": true} |
renovate-schema.json | pruneStaleBranches | Set to `false` to disable pruning stale branches. | {"type": "boolean", "default": true} |
renovate-schema.json | pub | Configuration object for the pub manager | {"type": "object", "default": {"fileMatch": ["(^|/)pubspec\\.ya?ml$"], "versioning": "npm"}} |
renovate-schema.json | puppet | Configuration object for the puppet manager | {"type": "object", "default": {"fileMatch": ["(^|/)Puppetfile$"]}} |
renovate-schema.json | pyenv | Configuration object for the pyenv manager | {"type": "object", "default": {"fileMatch": ["(^|/)\\.python-version$"], "versioning": "docker"}} |
renovate-schema.json | rangeStrategy | Determines how to modify or update existing ranges. | {"type": "string", "enum": ["auto", "pin", "bump", "replace", "widen", "update-lockfile", "in-range-only"], "default": "auto"} |
renovate-schema.json | rebaseLabel | Label to request a rebase from Renovate bot. | {"type": "string", "default": "rebase"} |
renovate-schema.json | rebaseWhen | Controls when Renovate rebases an existing branch. | {"type": "string", "enum": ["auto", "never", "conflicted", "behind-base-branch"], "default": "auto"} |
renovate-schema.json | recreateWhen | Recreate PRs even if same ones were closed previously. | {"type": "string", "enum": ["auto", "always", "never"], "default": "auto"} |
renovate-schema.json | redisUrl | If set, this Redis URL will be used for caching instead of the file system. | {"type": "string"} |
renovate-schema.json | regex | Configuration object for the regex manager | {"type": "object", "default": {"pinDigests": false}} |
renovate-schema.json | regexManagers | Custom managers using regex matching. | {"type": "array", "items": {"allOf": [{"type": "object", "properties": {"autoReplaceStringTemplate": {"type": "string"}, "currentValueTemplate": {"type": "string"}, "customType": {"type": "string", "enum": ["regex"]}, "datasourceTemplate": {"type": "string"}, "depNameTemplate": {"type": "string"}, "depTypeTemplate": {"type": "string"}, "extractVersionTemplate": {"type": "string"}, "matchStrings": {"type": "array", "items": {"type": "string", "format": "regex"}}, "matchStringsStrategy": {"type": "string", "enum": ["any", "recursive", "combination"], "default": "any"}, "packageNameTemplate": {"type": "string"}, "registryUrlTemplate": {"type": "string"}, "versioningTemplate": {"type": "string"}}}]}, "default": []} |
renovate-schema.json | description | A custom description for this configuration object | {"type": "string"} |
renovate-schema.json | autoReplaceStringTemplate | Optional `extractVersion` for extracted dependencies. Valid only within a `regexManagers` object. | {"type": "string"} |
renovate-schema.json | currentValueTemplate | Optional `currentValue` for extracted dependencies. Valid only within a `regexManagers` object. | {"type": "string"} |
renovate-schema.json | customType | Custom manager to use. Valid only within a `regexManagers` object. | {"type": "string", "enum": ["regex"]} |
renovate-schema.json | datasourceTemplate | Optional datasource for extracted dependencies. Valid only within a `regexManagers` object. | {"type": "string"} |
renovate-schema.json | depNameTemplate | Optional depName for extracted dependencies. Valid only within a `regexManagers` object. | {"type": "string"} |
renovate-schema.json | depTypeTemplate | Optional `depType` for extracted dependencies. Valid only within a `regexManagers` object. | {"type": "string"} |
renovate-schema.json | extractVersionTemplate | Optional `extractVersion` for extracted dependencies. Valid only within a `regexManagers` object. | {"type": "string"} |
renovate-schema.json | matchStrings | Regex capture rule to use. Valid only within a `regexManagers` object. | {"type": "array", "items": {"type": "string", "format": "regex"}} |
renovate-schema.json | matchStringsStrategy | Strategy how to interpret matchStrings. | {"type": "string", "enum": ["any", "recursive", "combination"], "default": "any"} |
renovate-schema.json | packageNameTemplate | Optional packageName for extracted dependencies, else defaults to `depName` value. Valid only within a `regexManagers` object. | {"type": "string"} |
renovate-schema.json | registryUrlTemplate | Optional registry URL for extracted dependencies. Valid only within a `regexManagers` object. | {"type": "string"} |
renovate-schema.json | versioningTemplate | Optional versioning for extracted dependencies. Valid only within a `regexManagers` object. | {"type": "string"} |
renovate-schema.json | registryAliases | Aliases for registries. | {"type": "object", "default": {}, "additionalProperties": {"type": "string", "format": "uri"}} |
renovate-schema.json | registryUrls | List of URLs to try for dependency lookup. Package manager specific. | {"type": "array", "items": {"type": "string"}, "default": null} |
renovate-schema.json | replacement | Configuration to apply when replacing a dependency. | {"type": "object", "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 `{{{depNameSanitized}}}` with the community suggested minimal stable replacement version."]}} |
renovate-schema.json | repositories | List of Repositories. | {"type": "array", "items": {"type": "string"}} |
renovate-schema.json | repositoryCache | This option decides if Renovate uses a JSON cache to speed up extractions. | {"type": "string", "enum": ["disabled", "enabled", "reset"], "default": "disabled"} |
renovate-schema.json | repositoryCacheType | Set the type of renovate repository cache if `repositoryCache` is enabled. | {"type": "string", "default": "local"} |
renovate-schema.json | requireConfig | Controls Renovate's behavior regarding repository config files such as `renovate.json`. | {"type": "string", "enum": ["required", "optional", "ignored"], "default": "required"} |
renovate-schema.json | respectLatest | Ignore versions newer than npm "latest" version. | {"type": "boolean"} |
renovate-schema.json | reviewers | Requested reviewers for Pull Requests (either username or email address depending on the platform). | {"type": "array", "items": {"type": "string"}} |
renovate-schema.json | reviewersFromCodeOwners | Determine reviewers based on configured code owners and changes in PR. | {"type": "boolean", "default": false} |
renovate-schema.json | reviewersSampleSize | Take a random sample of given size from `reviewers`. | {"type": "integer", "default": null} |
renovate-schema.json | rollback | Configuration to apply when rolling back a version. | {"type": "object", "default": {"branchTopic": "{{{depNameSanitized}}}-rollback", "commitMessageAction": "Roll back", "semanticCommitType": "fix"}} |
renovate-schema.json | rollbackPrs | Create PRs to roll back versions if the current version is not found in the registry. | {"type": "boolean", "default": false} |
renovate-schema.json | ruby-version | Configuration object for the ruby-version manager | {"type": "object", "default": {"fileMatch": ["(^|/)\\.ruby-version$"], "versioning": "ruby"}} |
renovate-schema.json | sbt | Configuration object for the sbt manager | {"type": "object", "default": {"fileMatch": ["\\.sbt$", "project/[^/]*\\.scala$", "project/build\\.properties$"], "versioning": "ivy"}} |
renovate-schema.json | schedule | Limit branch creation to these times of day or week. | {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}], "default": ["at any time"]} |
renovate-schema.json | secrets | Object which holds secret name/value pairs. | {"type": "object", "default": {}, "additionalProperties": {"type": "string"}} |
renovate-schema.json | semanticCommitScope | Commit scope to use if Semantic Commits are enabled. | {"type": "string", "default": "deps"} |
renovate-schema.json | semanticCommitType | Commit type to use if Semantic Commits is enabled. | {"type": "string", "default": "chore"} |
renovate-schema.json | semanticCommits | Enable Semantic Commit prefixes for commits and PR titles. | {"type": "string", "enum": ["auto", "enabled", "disabled"], "default": "auto"} |
renovate-schema.json | separateMajorMinor | If set to `false`, Renovate will upgrade dependencies to their latest release only. Renovate will not separate major or minor branches. | {"type": "boolean"} |
renovate-schema.json | separateMinorPatch | If set to `true`, Renovate will separate `minor` and `patch` updates into separate branches. | {"type": "boolean", "default": false} |
renovate-schema.json | separateMultipleMajor | If set to `true`, PRs will be raised separately for each available `major` upgrade version. | {"type": "boolean", "default": false} |
renovate-schema.json | setup-cfg | Configuration object for the setup-cfg manager | {"type": "object", "default": {"fileMatch": ["(^|/)setup\\.cfg$"], "versioning": "pep440"}} |
renovate-schema.json | skipInstalls | Skip installing modules/dependencies if lock file updating is possible without a full install. | {"type": "boolean", "default": null} |
renovate-schema.json | stopUpdatingLabel | Label to make Renovate stop updating a PR. | {"type": "string", "default": "stop-updating"} |
renovate-schema.json | suppressNotifications | Options to suppress various types of warnings and other notifications. | {"type": "array", "items": {"type": "string", "enum": ["artifactErrors", "branchAutomergeFailure", "configErrorIssue", "dependencyLookupWarnings", "deprecationWarningIssues", "lockFileErrors", "missingCredentialsError", "onboardingClose", "prEditedNotification", "prIgnoreNotification"]}, "default": ["deprecationWarningIssues"]} |
renovate-schema.json | swift | Configuration object for the swift manager | {"type": "object", "default": {"fileMatch": ["(^|/)Package\\.swift"], "versioning": "swift", "pinDigests": false}} |
renovate-schema.json | tekton | Configuration object for the tekton manager | {"type": "object", "default": {"fileMatch": []}} |
renovate-schema.json | terraform | Configuration object for the terraform manager | {"type": "object", "default": {"commitMessageTopic": "Terraform {{depName}}", "fileMatch": ["\\.tf$"], "pinDigests": false}} |
renovate-schema.json | terraform-version | Configuration object for the terraform-version manager | {"type": "object", "default": {"fileMatch": ["(^|/)\\.terraform-version$"], "versioning": "hashicorp", "extractVersion": "^v(?<version>.*)$"}} |
renovate-schema.json | terragrunt | Configuration object for the terragrunt manager | {"type": "object", "default": {"commitMessageTopic": "Terragrunt dependency {{depName}}", "fileMatch": ["(^|/)terragrunt\\.hcl$"]}} |
renovate-schema.json | terragrunt-version | Configuration object for the terragrunt-version manager | {"type": "object", "default": {"fileMatch": ["(^|/)\\.terragrunt-version$"], "versioning": "hashicorp", "extractVersion": "^v(?<version>.+)$"}} |
renovate-schema.json | tflint-plugin | Configuration object for the tflint-plugin manager | {"type": "object", "default": {"commitMessageTopic": "TFLint plugin {{depName}}", "fileMatch": ["\\.tflint\\.hcl$"], "extractVersion": "^v(?<version>.*)$"}} |
renovate-schema.json | timezone | [IANA Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) | {"type": "string"} |
renovate-schema.json | token | Repository Auth Token. | {"type": "string"} |
renovate-schema.json | transitiveRemediation | Enable remediation of transitive dependencies. | {"type": "boolean", "default": false} |
renovate-schema.json | travis | Configuration object for the travis manager | {"type": "object", "default": {"fileMatch": ["^\\.travis\\.ya?ml$"], "major": {"enabled": false}, "versioning": "node"}} |
renovate-schema.json | unicodeEmoji | Enable or disable Unicode emoji. | {"type": "boolean", "default": true} |
renovate-schema.json | updateInternalDeps | Whether to update internal dep versions in a monorepo. Works on Lerna or Yarn Workspaces. | {"type": "boolean", "default": false} |
renovate-schema.json | updateLockFiles | Set to `false` to disable lock file updating. | {"type": "boolean"} |
renovate-schema.json | updateNotScheduled | Whether to update branches when not scheduled. Renovate will not create branches outside of the schedule. | {"type": "boolean"} |
renovate-schema.json | updatePinnedDependencies | Whether to update pinned (single version) dependencies or not. | {"type": "boolean", "default": true} |
renovate-schema.json | useBaseBranchConfig | Whether to read configuration from `baseBranches` instead of only the default branch. | {"type": "string", "enum": ["merge", "none"], "default": "none"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.