UNPKG

renovate

Version:

Automated dependency updates. Flexible so you don't need to be.

1,690 lines (1,689 loc) • 115 kB
{ "title": "JSON schema for Renovate config files (https://renovatebot.com/)", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "addLabels": { "description": "Labels to add to Pull Request.", "type": "array", "items": { "type": "string" } }, "additionalBranchPrefix": { "description": "Additional string value to be appended to `branchPrefix`.", "type": "string", "default": "" }, "additionalReviewers": { "description": "Additional reviewers for Pull Requests (in contrast to `reviewers`, this option adds to the existing reviewer list, rather than replacing it).", "type": "array", "items": { "type": "string" } }, "allowCommandTemplating": { "description": "Set this to `false` to disable template compilation for post-upgrade commands.", "type": "boolean", "default": true }, "allowCustomCrateRegistries": { "description": "Set this to `true` to allow custom crate registries.", "type": "boolean", "default": false }, "allowPlugins": { "description": "Set this to `true` if repositories are allowed to run install plugins.", "type": "boolean", "default": false }, "allowScripts": { "description": "Set this to `true` if repositories are allowed to run install scripts.", "type": "boolean", "default": false }, "allowedCommands": { "description": "A list of regular expressions that decide which commands are allowed in post-upgrade tasks.", "type": "array", "items": { "type": "string" }, "default": [] }, "allowedEnv": { "description": "List of allowed patterns for environment variable names in repository env config.", "type": "array", "items": { "type": "string" }, "default": [] }, "allowedHeaders": { "description": "List of allowed patterns for header names in repository hostRules config.", "type": "array", "items": { "type": "string" }, "default": [ "X-*" ] }, "ansible": { "description": "Configuration object for the ansible manager", "type": "object", "default": { "fileMatch": [ "(^|/)tasks/[^/]+\\.ya?ml$" ] }, "$ref": "#" }, "ansible-galaxy": { "description": "Configuration object for the ansible-galaxy manager", "type": "object", "default": { "fileMatch": [ "(^|/)(galaxy|requirements)(\\.ansible)?\\.ya?ml$" ] }, "$ref": "#" }, "argocd": { "description": "Configuration object for the argocd manager", "type": "object", "default": { "fileMatch": [] }, "$ref": "#" }, "asdf": { "description": "Configuration object for the asdf manager", "type": "object", "default": { "fileMatch": [ "(^|/)\\.tool-versions$" ] }, "$ref": "#" }, "assignAutomerge": { "description": "Assign reviewers and assignees even if the PR is to be automerged.", "type": "boolean", "default": false }, "assignees": { "description": "Assignees for Pull Request (either username or email address depending on the platform).", "type": "array", "items": { "type": "string" } }, "assigneesFromCodeOwners": { "description": "Determine assignees based on configured code owners and changes in PR.", "type": "boolean", "default": false }, "assigneesSampleSize": { "description": "Take a random sample of given size from `assignees`.", "type": [ "integer", "null" ], "default": null }, "autoApprove": { "description": "Set to `true` to automatically approve PRs.", "type": "boolean", "default": false }, "autoReplaceGlobalMatch": { "description": "Control whether replacement regular expressions are global matches or only the first match.", "type": "boolean", "default": true }, "autodiscover": { "description": "Autodiscover all repositories.", "type": "boolean", "default": false }, "autodiscoverFilter": { "description": "Filter the list of autodiscovered repositories.", "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ], "default": null, "type": [ "array", "null" ] }, "autodiscoverNamespaces": { "description": "Filter the list of autodiscovered repositories by namespaces.", "type": [ "array", "null" ], "items": { "type": "string" }, "default": null }, "autodiscoverProjects": { "description": "Filter the list of autodiscovered repositories by project names.", "type": [ "array", "null" ], "items": { "type": "string" }, "default": null }, "autodiscoverRepoOrder": { "description": "The order method for autodiscover server side repository search.", "type": [ "string", "null" ], "enum": [ "asc", "desc" ], "default": null }, "autodiscoverRepoSort": { "description": "The sort method for autodiscover server side repository search.", "type": [ "string", "null" ], "enum": [ "alpha", "created", "updated", "size", "id" ], "default": null }, "autodiscoverTopics": { "description": "Filter the list of autodiscovered repositories by topics.", "type": [ "array", "null" ], "items": { "type": "string" }, "default": null }, "automerge": { "description": "Whether to automerge branches/PRs automatically, without human intervention.", "type": "boolean", "default": false }, "automergeComment": { "description": "PR comment to add to trigger automerge. Only used if `automergeType=pr-comment`.", "type": "string", "default": "automergeComment" }, "automergeSchedule": { "description": "Limit automerge to these times of day or week.", "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ], "default": [ "at any time" ] }, "automergeStrategy": { "description": "The merge strategy to use when automerging PRs. Used only if `automergeType=pr`.", "type": "string", "enum": [ "auto", "fast-forward", "merge-commit", "rebase", "squash" ], "default": "auto" }, "automergeType": { "description": "How to automerge, if enabled.", "type": "string", "enum": [ "branch", "pr", "pr-comment" ], "default": "pr" }, "azure-pipelines": { "description": "Configuration object for the azure-pipelines manager", "type": "object", "default": { "fileMatch": [ "(^|/).azuredevops/.+\\.ya?ml$", "azure.*pipelines?.*\\.ya?ml$" ], "enabled": false }, "$ref": "#" }, "azureWorkItemId": { "description": "The id of an existing work item on Azure Boards to link to each PR.", "type": "integer", "default": 0 }, "baseBranches": { "description": "List of one or more custom base branches defined as exact strings and/or via regex expressions.", "type": "array", "items": { "type": "string" } }, "baseDir": { "description": "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.", "type": "string" }, "batect": { "description": "Configuration object for the batect manager", "type": "object", "default": { "fileMatch": [ "(^|/)batect(-bundle)?\\.ya?ml$" ] }, "$ref": "#" }, "batect-wrapper": { "description": "Configuration object for the batect-wrapper manager", "type": "object", "default": { "fileMatch": [ "(^|/)batect$" ], "versioning": "semver" }, "$ref": "#" }, "bazel": { "description": "Configuration object for the bazel manager", "type": "object", "default": { "fileMatch": [ "(^|/)WORKSPACE(|\\.bazel|\\.bzlmod)$", "\\.WORKSPACE\\.bazel$", "\\.bzl$" ] }, "$ref": "#" }, "bazel-module": { "description": "Configuration object for the bazel-module manager", "type": "object", "default": { "fileMatch": [ "(^|/|\\.)MODULE\\.bazel$" ] }, "$ref": "#" }, "bazelisk": { "description": "Configuration object for the bazelisk manager", "type": "object", "default": { "fileMatch": [ "(^|/)\\.bazelversion$" ], "pinDigests": false, "versioning": "semver" }, "$ref": "#" }, "bbAutoResolvePrTasks": { "description": "The PR tasks will be automatically completed after the PR is raised.", "type": "boolean", "default": false }, "bbUseDefaultReviewers": { "description": "Use the default reviewers (Bitbucket only).", "type": "boolean", "default": true }, "bbUseDevelopmentBranch": { "description": "Use the repository's [development branch](https://support.atlassian.com/bitbucket-cloud/docs/branch-a-repository/#The-branching-model) as the repository's default branch.", "type": "boolean", "default": false }, "bicep": { "description": "Configuration object for the bicep manager", "type": "object", "default": { "fileMatch": [ "\\.bicep$" ] }, "$ref": "#" }, "binarySource": { "description": "Controls how third-party tools like npm or Gradle are called: directly, via Docker sidecar containers, or via dynamic install.", "type": "string", "enum": [ "global", "docker", "install", "hermit" ], "default": "install" }, "bitbucket-pipelines": { "description": "Configuration object for the bitbucket-pipelines manager", "type": "object", "default": { "fileMatch": [ "(^|/)\\.?bitbucket-pipelines\\.ya?ml$" ] }, "$ref": "#" }, "bitrise": { "description": "Configuration object for the bitrise manager", "type": "object", "default": { "fileMatch": [ "(^|/)bitrise\\.ya?ml$" ] }, "$ref": "#" }, "branchConcurrentLimit": { "description": "Limit to a maximum of x concurrent branches. 0 means no limit, `null` (default) inherits value from `prConcurrentLimit`.", "type": [ "integer", "null" ], "default": null }, "branchName": { "description": "Branch name template.", "type": "string", "default": "{{{branchPrefix}}}{{{additionalBranchPrefix}}}{{{branchTopic}}}" }, "branchNameStrict": { "description": "Whether to be strict about the use of special characters within the branch name.", "type": "boolean", "default": false }, "branchPrefix": { "description": "Prefix to use for all branch names.", "type": "string", "default": "renovate/" }, "branchPrefixOld": { "description": "Old branchPrefix value to check for existing PRs.", "type": "string", "default": "renovate/" }, "branchTopic": { "description": "Branch topic.", "type": "string", "default": "{{{depNameSanitized}}}-{{{newMajor}}}{{#if separateMinorPatch}}{{#if isPatch}}.{{{newMinor}}}{{/if}}{{/if}}.x{{#if isLockfileUpdate}}-lockfile{{/if}}" }, "buildkite": { "description": "Configuration object for the buildkite manager", "type": "object", "default": { "fileMatch": [ "buildkite\\.ya?ml", "\\.buildkite/.+\\.ya?ml$" ], "commitMessageTopic": "buildkite plugin {{depName}}", "commitMessageExtra": "to {{#if isMajor}}{{{prettyNewMajor}}}{{else}}{{{newValue}}}{{/if}}" }, "$ref": "#" }, "buildpacks": { "description": "Configuration object for the buildpacks manager", "type": "object", "default": { "commitMessageTopic": "buildpack {{depName}}", "fileMatch": [ "(^|/)project\\.toml$" ], "pinDigests": false }, "$ref": "#" }, "bumpVersion": { "description": "Bump the version in the package file being updated.", "type": "string", "enum": [ "major", "minor", "patch", "prerelease" ] }, "bun": { "description": "Configuration object for the bun manager", "type": "object", "default": { "fileMatch": [ "(^|/)bun\\.lockb?$" ], "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}})" } }, "$ref": "#" }, "bun-version": { "description": "Configuration object for the bun-version manager", "type": "object", "default": { "fileMatch": [ "(^|/)\\.bun-version$" ], "versioning": "npm" }, "$ref": "#" }, "bundler": { "description": "Configuration object for the bundler manager", "type": "object", "default": { "fileMatch": [ "(^|/)Gemfile$" ], "versioning": "ruby" }, "$ref": "#" }, "cacheDir": { "description": "The directory where Renovate stores its cache. If left empty, Renovate creates a subdirectory within the `baseDir`.", "type": "string" }, "cacheHardTtlMinutes": { "description": "Maximum duration in minutes to keep datasource cache entries.", "type": "integer", "default": 10080 }, "cachePrivatePackages": { "description": "Cache private packages in the datasource cache. This is useful for self-hosted setups", "type": "boolean", "default": false }, "cacheTtlOverride": { "description": "An object that contains cache namespace TTL override values.", "type": "object", "default": {}, "$ref": "#" }, "cake": { "description": "Configuration object for the cake manager", "type": "object", "default": { "fileMatch": [ "\\.cake$" ] }, "$ref": "#" }, "cargo": { "description": "Configuration object for the cargo manager", "type": "object", "default": { "commitMessageTopic": "Rust crate {{depName}}", "fileMatch": [ "(^|/)Cargo\\.toml$" ], "versioning": "cargo" }, "$ref": "#" }, "cdnurl": { "description": "Configuration object for the cdnurl manager", "type": "object", "default": { "fileMatch": [], "versioning": "semver" }, "$ref": "#" }, "checkedBranches": { "description": "A list of branch names to mark for creation or rebasing as if it was selected in the Dependency Dashboard issue.", "type": "array", "items": { "type": "string" }, "default": [] }, "circleci": { "description": "Configuration object for the circleci manager", "type": "object", "default": { "fileMatch": [ "(^|/)\\.circleci/.+\\.ya?ml$" ] }, "$ref": "#" }, "cloneSubmodules": { "description": "Set to `true` to initialize submodules during repository clone.", "type": "boolean", "default": false }, "cloneSubmodulesFilter": { "description": "List of submodules names or patterns to clone when cloneSubmodules=true.", "type": "array", "items": { "type": "string" }, "default": [ "*" ] }, "cloudbuild": { "description": "Configuration object for the cloudbuild manager", "type": "object", "default": { "fileMatch": [ "(^|/)cloudbuild\\.ya?ml" ] }, "$ref": "#" }, "cocoapods": { "description": "Configuration object for the cocoapods manager", "type": "object", "default": { "fileMatch": [ "(^|/)Podfile$" ], "versioning": "ruby" }, "$ref": "#" }, "commitBody": { "description": "Commit message body template. Will be appended to commit message, separated by two line returns.", "type": "string" }, "commitBodyTable": { "description": "If enabled, append a table in the commit message body describing all updates in the commit.", "type": "boolean", "default": false }, "commitMessage": { "description": "Message to use for commit messages and pull request titles.", "type": "string", "default": "{{{commitMessagePrefix}}} {{{commitMessageAction}}} {{{commitMessageTopic}}} {{{commitMessageExtra}}} {{{commitMessageSuffix}}}" }, "commitMessageAction": { "description": "Action verb to use in commit messages and PR titles.", "type": "string", "default": "Update" }, "commitMessageExtra": { "description": "Extra description used after the commit message topic - typically the version.", "type": "string", "default": "to {{#if isPinDigest}}{{{newDigestShort}}}{{else}}{{#if isMajor}}{{prettyNewMajor}}{{else}}{{#if isSingleVersion}}{{prettyNewVersion}}{{else}}{{#if newValue}}{{{newValue}}}{{else}}{{{newDigestShort}}}{{/if}}{{/if}}{{/if}}{{/if}}" }, "commitMessageLowerCase": { "description": "Lowercase PR- and commit titles.", "type": "string", "enum": [ "auto", "never" ], "default": "auto" }, "commitMessagePrefix": { "description": "Prefix to add to start of commit messages and PR titles. Uses a semantic prefix if `semanticCommits` is enabled.", "type": "string" }, "commitMessageSuffix": { "description": "Suffix to add to end of commit messages and PR titles.", "type": "string" }, "commitMessageTopic": { "description": "The upgrade topic/noun used in commit messages and PR titles.", "type": "string", "default": "dependency {{depName}}" }, "composer": { "description": "Configuration object for the composer manager", "type": "object", "default": { "fileMatch": [ "(^|/)([\\w-]*)composer\\.json$" ], "versioning": "composer" }, "$ref": "#" }, "composerIgnorePlatformReqs": { "description": "Configure use of `--ignore-platform-reqs` or `--ignore-platform-req` for the Composer package manager.", "type": "array", "items": { "type": "string" }, "default": [] }, "conan": { "description": "Configuration object for the conan manager", "type": "object", "default": { "fileMatch": [ "(^|/)conanfile\\.(txt|py)$" ], "datasource": "conan", "versioning": "conan", "enabled": false }, "$ref": "#" }, "confidential": { "description": "If enabled, issues created by Renovate are set as confidential.", "type": "boolean", "default": false }, "configMigration": { "description": "Enable this to get config migration PRs when needed.", "type": "boolean", "default": false }, "configWarningReuseIssue": { "description": "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 }, "constraints": { "description": "Configuration object to define language or manager version constraints.", "type": "object", "default": {}, "$ref": "#" }, "constraintsFiltering": { "description": "Perform release filtering based on language constraints.", "type": "string", "enum": [ "none", "strict" ], "default": "none" }, "containerbaseDir": { "description": "The directory where Renovate stores its containerbase cache. If left empty, Renovate creates a subdirectory within the `cacheDir`.", "type": "string" }, "copier": { "description": "Configuration object for the copier manager", "type": "object", "default": { "fileMatch": [ "(^|/)\\.copier-answers(\\..+)?\\.ya?ml" ], "versioning": "pep440" }, "$ref": "#" }, "cpanfile": { "description": "Configuration object for the cpanfile manager", "type": "object", "default": { "fileMatch": [ "(^|/)cpanfile$" ] }, "$ref": "#" }, "crossplane": { "description": "Configuration object for the crossplane manager", "type": "object", "default": { "fileMatch": [] }, "$ref": "#" }, "customDatasources": { "description": "Defines custom datasources for usage by managers.", "type": "object", "default": {}, "$ref": "#", "items": { "allOf": [ { "type": "object", "properties": { "description": { "oneOf": [ { "type": "array", "items": { "type": "string", "description": "A custom description for this configuration object" } }, { "type": "string", "description": "A custom description for this configuration object" } ] }, "defaultRegistryUrlTemplate": { "description": "Template for generating a `defaultRegistryUrl` for custom datasource.", "type": "string", "default": "" }, "format": { "description": "Format of the custom datasource.", "type": "string", "enum": [ "json", "plain" ], "default": "json" }, "transformTemplates": { "description": "List of jsonata transformation rules.", "type": "array", "items": { "type": "string" }, "default": [] } } } ] } }, "customEnvVariables": { "description": "Custom environment variables for child processes and sidecar Docker containers.", "type": "object", "default": {}, "$ref": "#" }, "customManagers": { "description": "Custom managers using regex matching.", "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "description": { "oneOf": [ { "type": "array", "items": { "type": "string", "description": "A custom description for this configuration object" } }, { "type": "string", "description": "A custom description for this configuration object" } ] }, "autoReplaceStringTemplate": { "description": "Optional `extractVersion` for extracted dependencies. Valid only within a `customManagers` object.", "type": "string" }, "currentValueTemplate": { "description": "Optional `currentValue` for extracted dependencies. Valid only within a `customManagers` object.", "type": "string" }, "customType": { "description": "Custom manager to use. Valid only within a `customManagers` object.", "type": "string", "enum": [ "jsonata", "regex" ] }, "datasourceTemplate": { "description": "Optional datasource for extracted dependencies. Valid only within a `customManagers` object.", "type": "string" }, "depNameTemplate": { "description": "Optional depName for extracted dependencies. Valid only within a `customManagers` object.", "type": "string" }, "depTypeTemplate": { "description": "Optional `depType` for extracted dependencies. Valid only within a `customManagers` object.", "type": "string" }, "extractVersionTemplate": { "description": "Optional `extractVersion` for extracted dependencies. Valid only within a `customManagers` object.", "type": "string" }, "fileFormat": { "description": "It specifies the syntax of the package file being managed by the custom JSONata manager.", "type": "string", "enum": [ "json", "toml", "yaml" ] }, "matchStrings": { "description": "Queries to use. Valid only within a `customManagers` object.", "type": "array", "items": { "type": "string" } }, "matchStringsStrategy": { "description": "Strategy how to interpret matchStrings.", "type": "string", "enum": [ "any", "recursive", "combination" ], "default": "any" }, "packageNameTemplate": { "description": "Optional packageName for extracted dependencies, else defaults to `depName` value. Valid only within a `customManagers` object.", "type": "string" }, "registryUrlTemplate": { "description": "Optional registry URL for extracted dependencies. Valid only within a `customManagers` object.", "type": "string" }, "versioningTemplate": { "description": "Optional versioning for extracted dependencies. Valid only within a `customManagers` object.", "type": "string" } } } ] }, "default": [] }, "customizeDashboard": { "description": "Customize sections in the Dependency Dashboard issue.", "type": "object", "default": {}, "additionalProperties": { "type": "string" } }, "defaultRegistryUrls": { "description": "List of registry URLs to use as the default for a datasource.", "type": [ "array", "null" ], "items": { "type": "string" }, "default": null }, "deleteConfigFile": { "description": "If set to `true`, Renovate tries to delete the self-hosted config file after reading it.", "type": "boolean", "default": false }, "dependencyDashboard": { "description": "Whether to create a \"Dependency Dashboard\" issue in the repository.", "type": "boolean", "default": false }, "dependencyDashboardApproval": { "description": "Controls if updates need manual approval from the Dependency Dashboard issue before PRs are created.", "type": "boolean", "default": false }, "dependencyDashboardAutoclose": { "description": "Set to `true` to let Renovate close the Dependency Dashboard issue if there are no more updates.", "type": "boolean", "default": false }, "dependencyDashboardFooter": { "description": "Any text added here will be placed last in the Dependency Dashboard issue body, with a divider separator before it.", "type": "string" }, "dependencyDashboardHeader": { "description": "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." }, "dependencyDashboardLabels": { "description": "These labels will always be applied on the Dependency Dashboard issue, even when they have been removed manually.", "type": [ "array", "null" ], "items": { "type": "string" }, "default": null }, "dependencyDashboardOSVVulnerabilitySummary": { "description": "Control if the Dependency Dashboard issue lists CVEs supplied by [osv.dev](https://osv.dev).", "type": "string", "enum": [ "none", "all", "unresolved" ], "default": "none" }, "dependencyDashboardTitle": { "description": "Title for the Dependency Dashboard issue.", "type": "string", "default": "Dependency Dashboard" }, "deps-edn": { "description": "Configuration object for the deps-edn manager", "type": "object", "default": { "fileMatch": [ "(^|/)(?:deps|bb)\\.edn$" ], "versioning": "maven" }, "$ref": "#" }, "description": { "description": "Plain text description for a config or preset.", "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ] }, "detectGlobalManagerConfig": { "description": "If `true`, Renovate tries to detect global manager configuration from the file system.", "type": "boolean", "default": false }, "detectHostRulesFromEnv": { "description": "If `true`, Renovate tries to detect host rules from environment variables.", "type": "boolean", "default": false }, "devbox": { "description": "Configuration object for the devbox manager", "type": "object", "default": { "fileMatch": [ "(^|/)devbox\\.json$" ] }, "$ref": "#" }, "devcontainer": { "description": "Configuration object for the devcontainer manager", "type": "object", "default": { "fileMatch": [ "^.devcontainer/devcontainer.json$", "^.devcontainer.json$" ] }, "$ref": "#" }, "digest": { "description": "Configuration to apply when updating a digest (no change in tag/version).", "type": "object", "default": { "branchTopic": "{{{depNameSanitized}}}-digest", "commitMessageExtra": "to {{newDigestShort}}", "commitMessageTopic": "{{{depName}}} digest" }, "$ref": "#" }, "docker-compose": { "description": "Configuration object for the docker-compose manager", "type": "object", "default": { "fileMatch": [ "(^|/)(?:docker-)?compose[^/]*\\.ya?ml$" ] }, "$ref": "#" }, "dockerChildPrefix": { "description": "Change this value to add a prefix to the Renovate Docker sidecar container names and labels.", "type": "string", "default": "renovate_" }, "dockerCliOptions": { "description": "Pass CLI flags to `docker run` command when `binarySource=docker`.", "type": "string" }, "dockerMaxPages": { "description": "By default, Renovate fetches up to 20 pages of Docker tags from registries. But you can set your own limit with this config option.", "type": "integer", "default": 20 }, "dockerSidecarImage": { "description": "Change this value to override the default Renovate sidecar image.", "type": "string", "default": "ghcr.io/containerbase/sidecar:13.8.9" }, "dockerUser": { "description": "Set the `UID` and `GID` for Docker-based binaries if you use `binarySource=docker`.", "type": "string" }, "dockerfile": { "description": "Configuration object for the dockerfile manager", "type": "object", "default": { "fileMatch": [ "(^|/|\\.)([Dd]ocker|[Cc]ontainer)file$", "(^|/)([Dd]ocker|[Cc]ontainer)file[^/]*$" ] }, "$ref": "#" }, "draftPR": { "description": "If set to `true` then Renovate creates draft PRs, instead of normal status PRs.", "type": "boolean", "default": false }, "droneci": { "description": "Configuration object for the droneci manager", "type": "object", "default": { "fileMatch": [ "(^|/)\\.drone\\.yml$" ] }, "$ref": "#" }, "dryRun": { "description": "If enabled, perform a dry run by logging messages instead of creating/updating/deleting branches and PRs.", "type": [ "string", "null" ], "enum": [ "extract", "lookup", "full" ], "default": null }, "enabled": { "description": "Enable or disable Renovate bot.", "type": "boolean", "default": true }, "enabledManagers": { "description": "A list of package managers to enable. Only managers on the list are enabled.", "type": "array", "items": { "type": "string" } }, "encrypted": { "description": "An object containing configuration encrypted with project key.", "type": [ "object", "null" ], "default": null, "$ref": "#" }, "encryptedWarning": { "description": "Warning text to use if encrypted config is found.", "type": "string" }, "endpoint": { "description": "Custom endpoint to use.", "type": [ "string", "null" ], "default": null }, "env": { "description": "Environment variables that Renovate uses when executing package manager commands.", "type": "object", "default": {}, "$ref": "#" }, "excludeCommitPaths": { "description": "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": [] }, "executionTimeout": { "description": "Default execution timeout in minutes for child processes Renovate creates.", "type": "integer", "default": 15 }, "expandCodeOwnersGroups": { "description": "Expand the configured code owner groups into a full list of group members.", "type": "boolean", "default": false }, "exposeAllEnv": { "description": "Set this to `true` to allow passing of all environment variables to package managers.", "type": "boolean", "default": false }, "extends": { "description": "Configuration presets to use or extend.", "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ] }, "extractVersion": { "description": "A regex (`re2`) to extract a version from a datasource's raw version string.", "type": "string", "format": "regex" }, "fetchChangeLogs": { "description": "Controls if and when changelogs/release notes are fetched.", "type": "string", "enum": [ "off", "branch", "pr" ], "default": "pr" }, "fileMatch": { "description": "RegEx (`re2`) pattern for matching manager files.", "oneOf": [ { "type": "array", "items": { "type": "string", "format": "regex" } }, { "type": "string", "format": "regex" } ] }, "filterUnavailableUsers": { "description": "Filter reviewers and assignees based on their availability.", "type": "boolean", "default": false }, "fleet": { "description": "Configuration object for the fleet manager", "type": "object", "default": { "fileMatch": [ "(^|/)fleet\\.ya?ml" ] }, "$ref": "#" }, "flux": { "description": "Configuration object for the flux manager", "type": "object", "default": { "fileMatch": [ "(?:^|/)gotk-components\\.ya?ml$" ] }, "$ref": "#" }, "followTag": { "description": "If defined, packages will follow this release tag exactly.", "type": "string" }, "force": { "description": "Any configuration set in this object will force override existing settings.", "type": "object", "$ref": "#" }, "forceCli": { "description": "Decides if CLI configuration options are moved to the `force` config section.", "type": "boolean", "default": true }, "forkCreation": { "description": "Whether to create forks as needed at runtime when running in \"fork mode\".", "type": "boolean", "default": true }, "forkModeDisallowMaintainerEdits": { "description": "Disallow maintainers to push to Renovate pull requests when running in fork mode.", "type": "boolean", "default": false }, "forkOrg": { "description": "The preferred organization to create or find forked repositories, when in fork mode.", "type": "string" }, "forkProcessing": { "description": "Whether to process forked repositories. By default, all forked repositories are skipped when in `autodiscover` mode.", "type": "string", "enum": [ "auto", "enabled", "disabled" ], "default": "auto" }, "forkToken": { "description": "Set a personal access token here to enable \"fork mode\".", "type": "string" }, "fvm": { "description": "Configuration object for the fvm manager", "type": "object", "default": { "fileMatch": [ "(^|/)\\.fvm/fvm_config\\.json$", "(^|/)\\.fvmrc$" ], "versioning": "semver" }, "$ref": "#" }, "git-submodules": { "description": "Configuration object for the git-submodules manager", "type": "object", "default": { "enabled": false, "versioning": "git", "fileMatch": [ "(^|/)\\.gitmodules$" ] }, "$ref": "#" }, "gitAuthor": { "description": "Author to use for Git commits. Must conform to [RFC5322](https://datatracker.ietf.org/doc/html/rfc5322).", "type": "string" }, "gitIgnoredAuthors": { "description": "Git authors which are ignored by Renovate. Must conform to [RFC5322](https://datatracker.ietf.org/doc/html/rfc5322).", "type": "array", "items": { "type": "string" } }, "gitLabIgnoreApprovals": { "description": "Ignore approval rules for MRs created by Renovate, which is useful for automerge.", "type": "boolean", "default": false }, "gitNoVerify": { "description": "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" ] }, "gitPrivateKey": { "description": "PGP key to use for signing Git commits.", "type": "string" }, "gitTimeout": { "description": "Configure the timeout with a number of milliseconds to wait for a Git task.", "type": "integer", "default": 0 }, "gitUrl": { "description": "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" }, "github-actions": { "description": "Configuration object for the github-actions manager", "type": "object", "default": { "fileMatch": [ "(^|/)(workflow-templates|\\.(?:github|gitea|forgejo)/(?:workflows|actions))/.+\\.ya?ml$", "(^|/)action\\.ya?ml$" ] }, "$ref": "#" }, "githubTokenWarn": { "description": "Display warnings about GitHub token not being set.", "type": "boolean", "default": true }, "gitlabci": { "description": "Configuration object for the gitlabci manager", "type": "object", "default": { "fileMatch": [ "\\.gitlab-ci\\.ya?ml$" ] }, "$ref": "#" }, "gitlabci-include": { "description": "Configuration object for the gitlabci-include manager", "type": "object", "default": { "fileMatch": [ "\\.gitlab-ci\\.ya?ml$" ] }, "$ref": "#" }, "glasskube": { "description": "Configuration object for the glasskube manager", "type": "object", "default": { "fileMatch": [] }, "$ref": "#" }, "gleam": { "description": "Configuration object for the gleam manager", "type": "object", "default": { "fileMatch": [ "(^|/)gleam.toml$" ], "versioning": "hex" }, "$ref": "#" }, "globalExtends": { "description": "Configuration presets to use or extend for a self-hosted config.", "type": "array", "items": { "type": "string" } }, "goGetDirs": { "description": "Directory pattern to run `go get` on.", "type": "array", "items": { "type": "string" }, "default": [ "./..." ] }, "gomod": { "description": "Configuration object for the gomod manager", "type": "object", "default": { "fileMatch": [ "(^|/)go\\.mod$" ], "pinDigests": false }, "$ref": "#" }, "gradle": { "description": "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" }, "$ref": "#" }, "gradle-wrapper": { "description": "Configuration object for the gradle-wrapper manager", "type": "object", "default": { "fileMatch": [ "(^|/)gradle/wrapper/gradle-wrapper\\.properties$" ], "versioning": "gradle" }, "$ref": "#" }, "group": { "description": "Config if `groupName` is enabled.", "type": "object", "default": { "branchTopic": "{{{groupSlug}}}", "commitMessageTopic": "{{{groupName}}}" }, "$ref": "#" }, "groupName": { "description": "Human understandable name for the dependency group.", "type": [ "string", "null" ], "default": null }, "groupSlug": { "description": "Slug to use for group (e.g. in branch name). Slug is calculated from `groupName` if `null`.", "type": [ "string", "null" ], "default": null }, "hashedBranchLength": { "description": "If enabled, branch names will use a hashing function to ensure each branch has that length.", "type": [ "integer", "null" ], "default": null }, "haskell-cabal": { "description": "Configuration object for the haskell-cabal manager", "type": "object", "default": { "fileMatch": [ "\\.cabal$" ], "pinDigests": false }, "$ref": "#" }, "helm-requirements": { "description": "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$" ] }, "$ref": "#" }, "helm-values": { "description": "Configuration object for the helm-values manager", "type": "object", "default": { "commitMessageTopic": "helm values {{depName}}", "fileMatch": [ "(^|/)values\\.ya?ml$" ], "pinDigests": false }, "$ref": "#" }, "helmfile": { "description": "Configuration object for the helmfile manager", "type": "object", "default": { "registryAliases": { "stable": "https://charts.helm.sh/stable" }, "commitMessageTopic": "helm chart {{depName}}", "fileMatch": [ "(^|/)helmfile\\.ya?ml(?:\\.gotmpl)?$" ] }, "$ref": "#" }, "helmsman": { "description": "Configuration object for the helmsman manager", "type": "object", "default": { "fileMatch": [] }, "$ref": "#" }, "helmv3": { "description": "Configuration object for the helmv3 manager", "type": "object", "default": { "registryAliases": { "stable": "https://charts.helm.sh/stable" }, "commitMessageTopic": "helm chart {{depName}}", "fileMatch": [ "(^|/)Chart\\.ya?ml$" ] }, "$ref": "#" }, "hermit": { "description": "Configuration object for the hermit manager", "type": "object", "default": { "fileMatch": [ "(^|/)bin/hermit$" ], "excludeCommitPaths": [ "**/bin/hermit" ], "versioning": "hermit" }, "$ref": "#" }, "homebrew": { "description": "Configuration object for the homebrew manager", "type": "object", "default": { "commitMessageTopic": "Homebrew Formula {{depName}}", "fileMatch": [ "^Formula/[^/]+[.]rb$" ] }, "$ref": "#" }, "hostRules": { "description": "Host rules/configuration including credentials.", "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "description": { "oneOf": [ { "type": "array", "items": { "type": "string", "description": "A custom description for this configuration object" } }, { "type": "string", "description": "A custom description for this configuration object" } ] }, "abortIgnoreStatusCodes": { "description": "A list of HTTP status codes safe to ignore even when `abortOnError=true`.", "type": "array", "items": { "type": "number" } }, "abortOnError": { "description": "If enabled, Renovate aborts its run when HTTP request errors occur.", "type": "boolean", "default": false }, "artifactAuth": { "description": "A list of package managers to enable artifact auth. Only managers on the list are enabled. All are enabled if `null`.", "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "composer" ] }, "default": null },