diff --git a/docs/usage/community-tools.md b/docs/usage/community-tools.md index ab5ca4460c..249af7a860 100644 --- a/docs/usage/community-tools.md +++ b/docs/usage/community-tools.md @@ -5,7 +5,7 @@ These tools are not officially supported by the Renovate team, but may be useful !!! note - If you have a community tool you'd like to add to this page, please open a pull request. + If you have a community tool you'd like to add to this page, please open a pull request. ## Renovate Operator (Kubernetes) diff --git a/docs/usage/config-overview.md b/docs/usage/config-overview.md index 97087b474c..5bb1670db7 100644 --- a/docs/usage/config-overview.md +++ b/docs/usage/config-overview.md @@ -23,7 +23,7 @@ If the item has the `mergeable` property, it will merge with lower numbers inste !!! note - If you use a Mend-hosted app, please read [Mend-hosted Apps Configuration](mend-hosted/hosted-apps-config.md) _after_ reading this page. + If you use a Mend-hosted app, please read [Mend-hosted Apps Configuration](mend-hosted/hosted-apps-config.md) _after_ reading this page. ## Types of config @@ -80,7 +80,7 @@ You may use synchronous or asynchronous methods inside a `.js` file, including e !!! warning - Do not name the additional config file `config.js` as it is reserved for file config. + Do not name the additional config file `config.js` as it is reserved for file config. #### Environment config @@ -100,8 +100,8 @@ Any additional Environment config variables take precedence over values in `RENO !!! warning - Make sure to escape any punctuation. - Be extra careful if you're passing stringified values. + Make sure to escape any punctuation. + Be extra careful if you're passing stringified values. Boolean: @@ -127,7 +127,7 @@ Objects, or lists with objects: !!! tip - Use "stringify" ([Example online service](https://jsonformatter.org/json-stringify-online)) for strings and objects. + Use "stringify" ([Example online service](https://jsonformatter.org/json-stringify-online)) for strings and objects. ##### Experimental variables @@ -276,7 +276,7 @@ Additionally for platforms which support nested Organization/Group hierarchies, !!! note - Renovate will also check for a `renovate.json` file if it cannot find a `default.json` file in a preset, however this option is deprecated and not recommended. + Renovate will also check for a `renovate.json` file if it cannot find a `default.json` file in a preset, however this option is deprecated and not recommended. If a default config is not found in a `renovate-config` repository within the Organization, Renovate will also check for the presence of a `renovate-config.json` file within a `.{{platform}}` repository parallel to the current repository. For example if the repository being onboarded is `abc/def` on a GitHub platform then Renovate will look for the existence of an `abc/.github` repository containing a `renovate-config.json` file. diff --git a/docs/usage/config-presets.md b/docs/usage/config-presets.md index 547fad2819..e30f81ae77 100644 --- a/docs/usage/config-presets.md +++ b/docs/usage/config-presets.md @@ -12,7 +12,7 @@ Shareable config presets must use the JSON or JSON5 formats, other formats are n !!! tip - Describe what your preset does in the `"description"` field or add comments as Renovate supports `JSONC` syntax within its preset files. + Describe what your preset does in the `"description"` field or add comments as Renovate supports `JSONC` syntax within its preset files. ## Extending from a preset @@ -27,8 +27,8 @@ Alternatively, Renovate can fetch preset files from an HTTP server. !!! warning - We deprecated npm-based presets. - We plan to drop the npm-based presets feature in a future major release of Renovate. + We deprecated npm-based presets. + We plan to drop the npm-based presets feature in a future major release of Renovate. You can set a Git tag (like a SemVer) to use a specific release of your shared config. @@ -40,8 +40,8 @@ If you wish to have an alternative file name, you need to specify it (e.g. `gith !!! warning - We've deprecated using a `renovate.json` file for the default _preset_ file name in a repository. - If you're using a `renovate.json` file to share your presets, rename it to `default.json`. + We've deprecated using a `renovate.json` file for the default _preset_ file name in a repository. + If you're using a `renovate.json` file to share your presets, rename it to `default.json`. ### GitHub @@ -107,9 +107,9 @@ If you wish to have an alternative file name, you need to specify it (e.g. `gith !!! tip - You can't combine the path and sub-preset syntaxes. - This means that anything in the form `provider>owner/repo//path/to/file:subsubpreset` is not supported. - One workaround is to use distinct files instead of sub-presets. + You can't combine the path and sub-preset syntaxes. + This means that anything in the form `provider>owner/repo//path/to/file:subsubpreset` is not supported. + One workaround is to use distinct files instead of sub-presets. ## Example configs @@ -121,8 +121,8 @@ It mostly uses Renovate config defaults but adds a few smart customizations such !!! note - The `:xyz` naming convention (with `:` prefix) is shorthand for the `default:` presets. - For example: `:xyz` is the same as `default:xyz`. + The `:xyz` naming convention (with `:` prefix) is shorthand for the `default:` presets. + For example: `:xyz` is the same as `default:xyz`. ## How to Use Preset Configs @@ -266,7 +266,7 @@ This can be handy when you want to include presets conditionally. !!! note - The template only supports a small subset of options, but you can extend them via `customEnvVariables`. + The template only supports a small subset of options, but you can extend them via `customEnvVariables`. Read the [templates](./templates.md) section to learn more. @@ -323,7 +323,7 @@ For example the result may be: !!! warning - Using npm-hosted presets is deprecated, we recommend you do not follow these instructions and instead use a `local` preset. + Using npm-hosted presets is deprecated, we recommend you do not follow these instructions and instead use a `local` preset. If you manage multiple repositories using Renovate and want the same custom config across all or most of them, then you might want to consider publishing your own preset config so that you can "extend" it in every applicable repository. That way when you want to change your Renovate configuration you can make the change in one location rather than having to copy/paste it to every repository individually. diff --git a/docs/usage/config-validation.md b/docs/usage/config-validation.md index b9a5f643c8..c811ed279a 100644 --- a/docs/usage/config-validation.md +++ b/docs/usage/config-validation.md @@ -58,8 +58,8 @@ $ npx --yes --package renovate -- renovate-config-validator first_config.json !!! note - If you specify the filename, `renovate-config-validator` treats the file(s) as global self-hosted configuration instead of repo-level configuration. - If this isn't intentional - for instance if you're validating a [shared config preset](./config-presets.md) or a non-standard filename - make sure you specify `--no-global`, i.e. `renovate-config-validator --no-global go-presets.json`. + If you specify the filename, `renovate-config-validator` treats the file(s) as global self-hosted configuration instead of repo-level configuration. + If this isn't intentional - for instance if you're validating a [shared config preset](./config-presets.md) or a non-standard filename - make sure you specify `--no-global`, i.e. `renovate-config-validator --no-global go-presets.json`. ### Providing global configuration @@ -96,7 +96,7 @@ Go to the [`renovatebot/pre-commit-hooks` repository](https://github.com/renovat !!! tip - Using the Mend-hosted apps? Push a branch to `renovate/reconfigure` for feedback (via status check), and if there's a PR, Renovate will add comments to it! + Using the Mend-hosted apps? Push a branch to `renovate/reconfigure` for feedback (via status check), and if there's a PR, Renovate will add comments to it! Renovate can validate configuration changes in Pull Requests when you use a special branch name. @@ -115,4 +115,4 @@ The next time Renovate runs on that repo it will: !!! note - The reconfigure branch **must** be pushed to the source repository that Renovate runs against, not a fork. + The reconfigure branch **must** be pushed to the source repository that Renovate runs against, not a fork. diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index 0be5fd72fe..48494eaf3e 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -17,12 +17,12 @@ The bot first checks all the files in the `configFileNames` array before checkin !!! warning - Storing the Renovate configuration in a `package.json` file is deprecated and support may be removed in the future. + Storing the Renovate configuration in a `package.json` file is deprecated and support may be removed in the future. !!! note - Renovate supports `JSONC` for `.json` files and any config files without file extension (e.g. `.renovaterc`). - We also recommend you prefer using `JSONC` within a `.json` file to using a `.json5` file if you want to add comments. + Renovate supports `JSONC` for `.json` files and any config files without file extension (e.g. `.renovaterc`). + We also recommend you prefer using `JSONC` within a `.json` file to using a `.json5` file if you want to add comments. When Renovate runs on a repository, it tries to find the configuration files in the order listed above. Renovate stops the search after it finds the first match. @@ -44,11 +44,11 @@ When an array or object configuration option is `mergeable`, it means that value !!! tip - This documentation corresponds with the JSON schema in [`docs.renovatebot.com/renovate-schema.json`](renovate-schema.json). + This documentation corresponds with the JSON schema in [`docs.renovatebot.com/renovate-schema.json`](renovate-schema.json). !!! note - Config options with `type=string` are always non-mergeable, so `mergeable=false`. + Config options with `type=string` are always non-mergeable, so `mergeable=false`. --- @@ -129,8 +129,8 @@ If you want to use dynamic labels, you can use [templates](./templates.md) such !!! note - Keep your labels within the maximum character limit for your Git hosting platform. - Renovate usually truncates labels to 50 characters, except for GitLab, which has a 255 character limit. + Keep your labels within the maximum character limit for your Git hosting platform. + Renovate usually truncates labels to 50 characters, except for GitLab, which has a 255 character limit. ## `additionalBranchPrefix` @@ -253,18 +253,18 @@ So for example you could choose to automerge all (passing) `devDependencies` onl !!! note - Branches creation follows [`schedule`](#schedule) and the automerge follows [`automergeSchedule`](#automergeschedule). + Branches creation follows [`schedule`](#schedule) and the automerge follows [`automergeSchedule`](#automergeschedule). !!! note - On Azure there can be a delay between a PR being set as completed by Renovate, and Azure merging the PR / finishing its tasks. - Renovate tries to delay until Azure is in the expected state, but it will continue if it takes too long. - In some cases this can result in a dependency not being merged, and a fresh PR being created for the dependency. + On Azure there can be a delay between a PR being set as completed by Renovate, and Azure merging the PR / finishing its tasks. + Renovate tries to delay until Azure is in the expected state, but it will continue if it takes too long. + In some cases this can result in a dependency not being merged, and a fresh PR being created for the dependency. !!! note - By default, Renovate will not assign reviewers and assignees to an automerge-enabled PR unless it fails status checks. - By configuring [`assignAutomerge`](#assignautomerge) setting to `true`, Renovate will instead always assign reviewers and assignees for automerging PRs at time of creation. + By default, Renovate will not assign reviewers and assignees to an automerge-enabled PR unless it fails status checks. + By configuring [`assignAutomerge`](#assignautomerge) setting to `true`, Renovate will instead always assign reviewers and assignees for automerging PRs at time of creation. **Automerge and GitHub branch protection rules** @@ -298,8 +298,8 @@ To configure this option refer to [`schedule`](#schedule) as the syntax is the s !!! warning - When `platformAutomerge` is enabled, Renovate enqueues the platform PR automerge at time of creation, so the schedule specified in `automergeSchedule` cannot be followed. - If it's essential that automerging only happens within the specific `automergeSchedule` time window, then you need to set `platformAutomerge` to `false` and instead rely on Renovate's automerge instead of the platform one. + When `platformAutomerge` is enabled, Renovate enqueues the platform PR automerge at time of creation, so the schedule specified in `automergeSchedule` cannot be followed. + If it's essential that automerging only happens within the specific `automergeSchedule` time window, then you need to set `platformAutomerge` to `false` and instead rely on Renovate's automerge instead of the platform one. ## `automergeStrategy` @@ -334,7 +334,7 @@ If Renovate is scheduled for hourly runs on the repository but commits are made !!! tip - If you have no tests but still want Renovate to automerge, you need to add `"ignoreTests": true` to your configuration. + If you have no tests but still want Renovate to automerge, you need to add `"ignoreTests": true` to your configuration. If you prefer that Renovate more silently automerge _without_ Pull Requests at all, you can configure `"automergeType": "branch"`. In this case Renovate will: @@ -397,8 +397,8 @@ You can also use the special `"$default"` string to denote the repository's defa !!! note - Do _not_ use the `baseBranchPatterns` config option when you've set a `forkToken`. - You may need a `forkToken` when you're using the Forking Renovate app. + Do _not_ use the `baseBranchPatterns` config option when you've set a `forkToken`. + You may need a `forkToken` when you're using the Forking Renovate app. ## `bbAutoResolvePrTasks` @@ -429,8 +429,8 @@ Example config: !!! warning - Leaving PRs/branches as unlimited or as a high number increases the time it takes for Renovate to process a repository. - If you find that Renovate is too slow when rebasing out-of-date branches, decrease the `branchConcurrentLimit`. + Leaving PRs/branches as unlimited or as a high number increases the time it takes for Renovate to process a repository. + If you find that Renovate is too slow when rebasing out-of-date branches, decrease the `branchConcurrentLimit`. If you have too many concurrent branches which rebase themselves each run, Renovate can take a lot of time to rebase. Solutions: @@ -457,8 +457,8 @@ The default `false` behavior will mean that special characters like `.` and `/` !!! note - Renovate will not apply any search/replace to the `branchPrefix` part of the branch name. - If you don't want any `/` in your branch name then you will also need to change `branchPrefix` from the default `renovate/` value to something like `renovate-`. + Renovate will not apply any search/replace to the `branchPrefix` part of the branch name. + If you don't want any `/` in your branch name then you will also need to change `branchPrefix` from the default `renovate/` value to something like `renovate-`. ## `branchPrefix` @@ -471,8 +471,8 @@ e.g. instead of `renovate/{{parentDir}}-`, configure the template part in `addit !!! note - This setting does not change the default _onboarding_ branch name, i.e. `renovate/configure`. - If you wish to change that too, you need to also configure the field `onboardingBranch` in your global bot config. + This setting does not change the default _onboarding_ branch name, i.e. `renovate/configure`. + If you wish to change that too, you need to also configure the field `onboardingBranch` in your global bot config. ## `branchPrefixOld` @@ -527,8 +527,8 @@ The option is an array of rules, each specifying how and where to bump versions. !!! tip - You can use templates in `filePatternTemplates`, `bumpType`, and `matchStrings`. - This way you can leverage the power of Renovate's templating engine to change based on the context of the upgrade. + You can use templates in `filePatternTemplates`, `bumpType`, and `matchStrings`. + This way you can leverage the power of Renovate's templating engine to change based on the context of the upgrade. Here is an example of a `bumpVersions` configuration: @@ -648,8 +648,8 @@ When Renovate updates a dependency to version `2.5.3`, it will also update the ` !!! note - When using `bumpType: "sync"`, Renovate uses the `newVersion` from the first upgrade in the branch. - If no upgrades are found in the branch, the version bump will be skipped and a debug message will be logged. + When using `bumpType: "sync"`, Renovate uses the `newVersion` from the first upgrade in the branch. + If no upgrades are found in the branch, the version bump will be skipped and a debug message will be logged. ### `bumpVersions.filePatterns` @@ -751,7 +751,7 @@ If you only want to limit the rate of _new_ PRs, use [prHourlyLimit](#prhourlyli !!! tip - Manual rebases (requested via checkbox, Dependency Dashboard, or rebase label) always bypass this limit. + Manual rebases (requested via checkbox, Dependency Dashboard, or rebase label) always bypass this limit. ## `commitMessage` @@ -825,12 +825,12 @@ If enabled, all issues created by Renovate are set as confidential, even in a pu !!! note - The Dependency Dashboard issue will also be confidential. - By default issues created by Renovate are visible to all users. + The Dependency Dashboard issue will also be confidential. + By default issues created by Renovate are visible to all users. !!! note - This option is applicable to GitLab only. + This option is applicable to GitLab only. ## `configMigration` @@ -855,10 +855,10 @@ After we changed the [`baseBranchPatterns`](#basebranchpatterns) feature, the Re !!! warning - The `configMigration` feature writes plain JSON for `.json` files, and JSON5 for `.json5` files. - Renovate may downgrade JSON5 content to plain JSON. - When downgrading JSON5 to JSON Renovate may also remove the JSON5 comments. - This can happen because Renovate wrongly converts JSON5 to JSON, thus removing the comments. + The `configMigration` feature writes plain JSON for `.json` files, and JSON5 for `.json5` files. + Renovate may downgrade JSON5 content to plain JSON. + When downgrading JSON5 to JSON Renovate may also remove the JSON5 comments. + This can happen because Renovate wrongly converts JSON5 to JSON, thus removing the comments. For more details, read the [config migration documentation](./config-migration.md). @@ -903,7 +903,7 @@ The following `constraints` are available to specify which package managers/lang !!! note - When using [`binarySource=global`](./self-hosted-configuration.md#binarysource), the `constraints` options do not take effect. + When using [`binarySource=global`](./self-hosted-configuration.md#binarysource), the `constraints` options do not take effect. Additionally, there are several additional constraints that can be specified: @@ -911,7 +911,7 @@ Additionally, there are several additional constraints that can be specified: !!! note - Make sure not to mix this up with the term `compatibility`, which Renovate uses in the context of version releases, e.g. if a Docker image is `node:12.16.0-alpine` then the `-alpine` suffix represents `compatibility`. + Make sure not to mix this up with the term `compatibility`, which Renovate uses in the context of version releases, e.g. if a Docker image is `node:12.16.0-alpine` then the `-alpine` suffix represents `compatibility`. ## `constraintsFiltering` @@ -940,12 +940,12 @@ Sometimes when using private registries they may omit constraints information, w !!! warning - Enabling this feature may result in many package updates being filtered out silently. - See below for a description of how it works. + Enabling this feature may result in many package updates being filtered out silently. + See below for a description of how it works. !!! warning - Enabling this feature when using [`binarySource=global`](./self-hosted-configuration.md#binarysource) can lead to situations where Renovate suggests updates that it cannot then update, as it does not have the right tool versions installed. + Enabling this feature when using [`binarySource=global`](./self-hosted-configuration.md#binarysource) can lead to situations where Renovate suggests updates that it cannot then update, as it does not have the right tool versions installed. When `constraintsFiltering=strict`, the following logic applies: @@ -974,7 +974,7 @@ Use `constraintsVersioning` to override the versioning scheme used when filterin !!! note - Each key must be an [additional constraint name](#constraints) (i.e. not a tool name), and each value must be a valid versioning scheme ID. + Each key must be an [additional constraint name](#constraints) (i.e. not a tool name), and each value must be a valid versioning scheme ID. Datasources that support constraints filtering may set sensible defaults for their constraints. You can override these defaults in your Renovate config. @@ -1071,7 +1071,7 @@ For template fields, use the triple brace `{{{ }}}` notation to avoid Handlebars !!! tip - Look at our [Custom Manager Presets](./presets-customManagers.md), they may have what you need. + Look at our [Custom Manager Presets](./presets-customManagers.md), they may have what you need. ### `customManagers.autoReplaceStringTemplate` @@ -1110,7 +1110,7 @@ image: my.new.registry/aRepository/andImage:1.21-alpine !!! note - Can only be used with the custom regex manager. + Can only be used with the custom regex manager. ### `customManagers.currentValueTemplate` @@ -1176,7 +1176,7 @@ It will be compiled using Handlebars and the regex `groups` result. !!! note - Can only be used with the custom jsonata manager. + Can only be used with the custom jsonata manager. It specifies the syntax of the package file that's managed by the custom `jsonata` manager. This setting helps the system correctly parse and interpret the configuration file's contents. @@ -1256,7 +1256,7 @@ Example: !!! note - You do not need to add leading and trailing slashes in `matchStrings`. + You do not need to add leading and trailing slashes in `matchStrings`. ### `customManagers.matchStringsStrategy` @@ -1269,7 +1269,7 @@ Three options are available: !!! note - `matchStringsStrategy` can only be used in a custom regex manager config! + `matchStringsStrategy` can only be used in a custom regex manager config! #### any @@ -1472,9 +1472,9 @@ Examples of what having a Dependency Dashboard will allow you to do: !!! tip - Enabling the Dependency Dashboard by itself does _not_ change the "control flow" of Renovate. - Renovate still creates and manages PRs, and still follows your schedules and rate limits. - The Dependency Dashboard gives you extra visibility and control over your updates. + Enabling the Dependency Dashboard by itself does _not_ change the "control flow" of Renovate. + Renovate still creates and manages PRs, and still follows your schedules and rate limits. + The Dependency Dashboard gives you extra visibility and control over your updates. ## `dependencyDashboardApproval` @@ -1485,7 +1485,7 @@ You can approve a pending PR by selecting the checkbox in the Dependency Dashboa !!! tip - When you set `dependencyDashboardApproval` to `true` the Dependency Dashboard issue will be created automatically, you do not need to turn on `dependencyDashboard` explicitly. + When you set `dependencyDashboardApproval` to `true` the Dependency Dashboard issue will be created automatically, you do not need to turn on `dependencyDashboard` explicitly. You can configure Renovate to wait for approval for: @@ -1617,8 +1617,8 @@ This option is evaluated at PR/MR creation time. !!! note - Forgejo, Gitea and GitLab implement draft status by checking if the PR's title starts with certain strings. - This means that `draftPR` on Forgejo, Gitea and GitLab are incompatible with the legacy method of triggering Renovate to rebase a PR by renaming the PR to start with `rebase!`. + Forgejo, Gitea and GitLab implement draft status by checking if the PR's title starts with certain strings. + This means that `draftPR` on Forgejo, Gitea and GitLab are incompatible with the legacy method of triggering Renovate to rebase a PR by renaming the PR to start with `rebase!`. ## `enabled` @@ -1634,7 +1634,7 @@ For example, if you wanted to disable Renovate completely on a repository, you c !!! note - When Renovate is disabled on a repository entirely (via `enabled=false`), if Renovate runs against the repo again, it will perform a one-time cleanup of the repository, closing open Issues, PRs and deleting any branches. + When Renovate is disabled on a repository entirely (via `enabled=false`), if Renovate runs against the repo again, it will perform a one-time cleanup of the repository, closing open Issues, PRs and deleting any branches. To disable Renovate for all `eslint` packages, you can configure a package rule like: @@ -1716,8 +1716,8 @@ Its primary value is validating that the string you echo to `gpg` is valid JSON, !!! note - Encrypted secrets must have at least an org/group scope, and optionally a repository scope. - This means that Renovate will check if a secret's scope matches the current repository before applying it, and warn/discard if there is a mismatch. + Encrypted secrets must have at least an org/group scope, and optionally a repository scope. + This means that Renovate will check if a secret's scope matches the current repository before applying it, and warn/discard if there is a mismatch. Encrypted secrets usually have a single organization. But you may encrypt a secret with more than one organization, for example: `org1,org2`. @@ -1732,7 +1732,7 @@ It is valid only as a top-level configuration option and not, for example, withi !!! warning - The bot administrator must configure a list of allowed environment names in the [`allowedEnv`](./self-hosted-configuration.md#allowedenv) config option, before users can use those allowed names in the `env` option. + The bot administrator must configure a list of allowed environment names in the [`allowedEnv`](./self-hosted-configuration.md#allowedenv) config option, before users can use those allowed names in the `env` option. Behavior: @@ -1867,9 +1867,9 @@ which can be time-consuming due to the repository's large number of tags: !!! note - Renovate can only show changelogs from some platforms and some package managers. - We're planning improvements so that Renovate can show more changelogs. - Read [issue 14138 on GitHub](https://github.com/renovatebot/renovate/issues/14138) to get an overview of the planned work. + Renovate can only show changelogs from some platforms and some package managers. + We're planning improvements so that Renovate can show more changelogs. + Read [issue 14138 on GitHub](https://github.com/renovatebot/renovate/issues/14138) to get an overview of the planned work. ## `filterUnavailableUsers` @@ -1914,7 +1914,7 @@ If this option is enabled, reviewers will need to create a new PR if more change !!! note - This option is only relevant if you set `forkToken`. + This option is only relevant if you set `forkToken`. ## `forkProcessing` @@ -1957,7 +1957,7 @@ When this field is unset (default), Renovate will use its platform credentials ( !!! note - If running as a GitHub App and using `platformCommit`, GitHub itself sets the git author in commits so you should not configure this field. + If running as a GitHub App and using `platformCommit`, GitHub itself sets the git author in commits so you should not configure this field. The `gitAuthor` option accepts a [RFC5322](https://datatracker.ietf.org/doc/html/rfc5322)-compliant string. It's recommended to include a name followed by an email address, e.g. @@ -1968,8 +1968,8 @@ Development Bot !!! danger - We strongly recommend that the Git author email you use is unique to Renovate. - Otherwise, if another bot or human shares the same email and pushes to one of Renovate's branches then Renovate will mistake the branch as unmodified and potentially force push over the changes. + We strongly recommend that the Git author email you use is unique to Renovate. + Otherwise, if another bot or human shares the same email and pushes to one of Renovate's branches then Renovate will mistake the branch as unmodified and potentially force push over the changes. ## `gitIgnoredAuthors` @@ -2036,9 +2036,9 @@ For example, to group all non-major devDependencies updates together into a sing !!! note - Replacement updates will never be grouped. -
- Lock file maintenance will never be grouped with other dependency updates. + Replacement updates will never be grouped. +
+ Lock file maintenance will never be grouped with other dependency updates. ## `groupSlug` @@ -2063,7 +2063,7 @@ As a result of the above, the branchName would be `renovate/dev-dependencies` in !!! note - You shouldn't usually need to configure this unless you really care about your branch names. + You shouldn't usually need to configure this unless you really care about your branch names. ## `hashedBranchLength` @@ -2137,12 +2137,12 @@ To match specific ports you have to add a protocol to `matchHost`: !!! warning - Using `matchHost` without a protocol behaves the same as if you had set no `matchHost` configuration. + Using `matchHost` without a protocol behaves the same as if you had set no `matchHost` configuration. !!! note - Disabling a host is only 100% effective if added to self-hosted config. - Renovate currently still checks its _cache_ for results first before trying to connect, so if a public host is blocked in your repository config (e.g. `renovate.json`) then it's possible you may get cached _results_ from that host if another repository using the same bot has successfully queried for the same dependency recently. + Disabling a host is only 100% effective if added to self-hosted config. + Renovate currently still checks its _cache_ for results first before trying to connect, so if a public host is blocked in your repository config (e.g. `renovate.json`) then it's possible you may get cached _results_ from that host if another repository using the same bot has successfully queried for the same dependency recently. ### `hostRules.abortIgnoreStatusCodes` @@ -2162,7 +2162,7 @@ For example to also skip 404 responses then configure the following: !!! tip - This field is _not_ mergeable, so the last-applied host rule takes precedence. + This field is _not_ mergeable, so the last-applied host rule takes precedence. ### `hostRules.abortOnError` @@ -2350,8 +2350,8 @@ Specifies the private key in [PEM format](https://en.wikipedia.org/wiki/Privacy- !!! warning - Do _not_ put your private key into this field, to avoid losing confidentiality completely. - You must use [secrets](./self-hosted-configuration.md#secrets) to pass it down securely instead. + Do _not_ put your private key into this field, to avoid losing confidentiality completely. + You must use [secrets](./self-hosted-configuration.md#secrets) to pass it down securely instead. ### `hostRules.insecureRegistry` @@ -2403,7 +2403,7 @@ registry=https://gitlab.myorg.com/api/v4/packages/npm/ !!! note - Values containing a URL path but missing a scheme will be prepended with 'https://' (e.g. `domain.com/path` → `https://domain.com/path`) + Values containing a URL path but missing a scheme will be prepended with 'https://' (e.g. `domain.com/path` → `https://domain.com/path`) ### `hostRules.maxRequestsPerSecond` @@ -2680,8 +2680,8 @@ If you want to add/combine labels, use the `addLabels` config option, which is m !!! note - Keep your labels within the maximum character limit for your Git hosting platform. - Renovate usually truncates labels to 50 characters, except for GitLab, which has a 255 character limit. + Keep your labels within the maximum character limit for your Git hosting platform. + Renovate usually truncates labels to 50 characters, except for GitLab, which has a 255 character limit. ## `lockFileMaintenance` @@ -2875,8 +2875,8 @@ Example: !!! note - Minimum Release Age has [a separate documentation page](./key-concepts/minimum-release-age.md) for more in-depth documentation about the functionality. - This also includes documentation that was previously in this section, regarding how to specify release timestamps for custom registries. + Minimum Release Age has [a separate documentation page](./key-concepts/minimum-release-age.md) for more in-depth documentation about the functionality. + This also includes documentation that was previously in this section, regarding how to specify release timestamps for custom registries. If `minimumReleaseAge` is set to a time duration _and_ the update has a release timestamp header, then Renovate will check if the set duration has passed. This behaviour can be changed using [`minimumReleaseAgeBehaviour`](#minimumreleaseagebehaviour). @@ -2897,11 +2897,11 @@ You can confirm if your datasource supports the release timestamp by viewing [th !!! note - Configuring this option will add a `renovate/stability-days` option to the status checks. + Configuring this option will add a `renovate/stability-days` option to the status checks. !!! note - As of Renovate 42.19.5, using `minimumReleaseAge=0 days` is treated the same as `minimumReleaseAge=null`. + As of Renovate 42.19.5, using `minimumReleaseAge=0 days` is treated the same as `minimumReleaseAge=null`. Examples of how you can use `minimumReleaseAge`: @@ -3019,7 +3019,7 @@ The entire database is downloaded locally by [osv-offline](https://github.com/re !!! note - This functionality is currently experimental, being actively worked on, and will soon be available for usage outside of `osvVulnerabilityAlerts`. + This functionality is currently experimental, being actively worked on, and will soon be available for usage outside of `osvVulnerabilityAlerts`. If Renovate detects a malicious dependency using data from OSV, it will surface this in log warnings, and prevent PRs from being created. @@ -3128,12 +3128,12 @@ For example you have multiple `package.json` and want to use `dependencyDashboar !!! tip - Order your `packageRules` so the least important rules are at the _top_, and the most important rules at the _bottom_. - This way important rules override settings from earlier rules if needed. + Order your `packageRules` so the least important rules are at the _top_, and the most important rules at the _bottom_. + This way important rules override settings from earlier rules if needed. !!! warning - Avoid nesting any `object`-type configuration in a `packageRules` array, such as a `major` or `minor` block. + Avoid nesting any `object`-type configuration in a `packageRules` array, such as a `major` or `minor` block. ### `packageRules.allowedVersions` @@ -3176,7 +3176,7 @@ For example, if you want to upgrade to Angular to only the next major, you could !!! warning - `allowedVersions` and `matchUpdateTypes` cannot be used in the same package rule. + `allowedVersions` and `matchUpdateTypes` cannot be used in the same package rule. #### Using regular expressions @@ -3249,7 +3249,7 @@ To read the changelogs you must use the link. !!! note - Renovate can fetch changelogs from Bitbucket, Bitbucket Server / Data Center, Forgejo, Gitea, GitHub and GitLab platforms only, and setting the URL to an unsupported host/platform type won't change that. + Renovate can fetch changelogs from Bitbucket, Bitbucket Server / Data Center, Forgejo, Gitea, GitHub and GitLab platforms only, and setting the URL to an unsupported host/platform type won't change that. For more details on supported syntax see Renovate's [string pattern matching documentation](./string-pattern-matching.md). @@ -3291,8 +3291,8 @@ The categories can be found in the [manager documentation](modules/manager/index !!! note - Rules with `matchCategories` are only applied _after_ extraction of dependencies. - If you want to configure which managers are being extracted at all, use `enabledManagers` instead. + Rules with `matchCategories` are only applied _after_ extraction of dependencies. + If you want to configure which managers are being extracted at all, use `enabledManagers` instead. ```json { @@ -3309,8 +3309,8 @@ The categories can be found in the [manager documentation](modules/manager/index !!! warning - This configuration option needs a Mend API key, and is in private beta testing only. - API keys are not available for free or via the `renovatebot/renovate` repository. + This configuration option needs a Mend API key, and is in private beta testing only. + API keys are not available for free or via the `renovatebot/renovate` repository. ```json title="Grouping high merge confidence updates" { @@ -3347,7 +3347,7 @@ Instead you should do `> 13 months`. !!! note - We recommend you only use the words hour(s), day(s), week(s), month(s) and year(s) in your time ranges. + We recommend you only use the words hour(s), day(s), week(s), month(s) and year(s) in your time ranges. ### `packageRules.matchCurrentValue` @@ -3733,14 +3733,14 @@ For more details on supported syntax see Renovate's [string pattern matching doc !!! warning - Packages that follow SemVer are allowed to make breaking changes in _any_ `0.x` version, even `patch` and `minor`. - Check if you're using any `0.x` package, and see if you need custom `packageRules` for it. - When setting up automerge for dependencies, make sure to stop accidental automerges of `0.x` versions. - Read the [automerge non-major updates](./key-concepts/automerge.md#automerge-non-major-updates) docs for a config example that blocks `0.x` updates. + Packages that follow SemVer are allowed to make breaking changes in _any_ `0.x` version, even `patch` and `minor`. + Check if you're using any `0.x` package, and see if you need custom `packageRules` for it. + When setting up automerge for dependencies, make sure to stop accidental automerges of `0.x` versions. + Read the [automerge non-major updates](./key-concepts/automerge.md#automerge-non-major-updates) docs for a config example that blocks `0.x` updates. !!! warning - `matchUpdateTypes` and `allowedVersions` cannot be used in the same package rule. + `matchUpdateTypes` and `allowedVersions` cannot be used in the same package rule. Tokens can be configured via `hostRules` using the `"merge-confidence"` `hostType`: @@ -3864,15 +3864,15 @@ You can suggest a new community package rule by editing [the `replacements.json` !!! note - Replacement updates will never be grouped. -
- Lock file maintenance will never be grouped with other dependency updates. + Replacement updates will never be grouped. +
+ Lock file maintenance will never be grouped with other dependency updates. ### `packageRules.replacementNameTemplate` !!! note - `replacementName` will take precedence if used within the same package rule. + `replacementName` will take precedence if used within the same package rule. Use the `replacementNameTemplate` config option to control the replacement name. @@ -3940,7 +3940,7 @@ For example to replace the npm package `jade` with version `2.0.0` of the packag !!! note - `replacementVersion` will take precedence if used within the same package rule. + `replacementVersion` will take precedence if used within the same package rule. Use the `replacementVersionTemplate` config option to control the replacement version. @@ -3975,7 +3975,7 @@ Use this field to set the directory in which the package is present at the sourc !!! note - `sourceDirectory` should be only be configured along with `sourceUrl`. + `sourceDirectory` should be only be configured along with `sourceUrl`. ### `packageRules.sourceUrl` @@ -4029,12 +4029,12 @@ If enabled Renovate will pin Docker images or GitHub Actions by means of their S !!! note - If you use the default `platformAutomerge=true` then you should enable your Git hosting platform's capabilities to enforce test passing before PR merge. - If you don't do this, the platform might merge Renovate PRs even if the repository's tests haven't started, are in still in progress, or possibly even when they have failed. - On GitHub this is called "Require status checks before merging", which you can find in the "Branch protection rules" section of the settings for your repository. - [GitHub docs, about protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches) - [GitHub docs, require status checks before merging](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-status-checks-before-merging) - If you're using another platform, search their documentation for a similar feature. + If you use the default `platformAutomerge=true` then you should enable your Git hosting platform's capabilities to enforce test passing before PR merge. + If you don't do this, the platform might merge Renovate PRs even if the repository's tests haven't started, are in still in progress, or possibly even when they have failed. + On GitHub this is called "Require status checks before merging", which you can find in the "Branch protection rules" section of the settings for your repository. + [GitHub docs, about protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches) + [GitHub docs, require status checks before merging](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-status-checks-before-merging) + If you're using another platform, search their documentation for a similar feature. If you have enabled `automerge` and set `automergeType=pr` in the Renovate config, then leaving `platformAutomerge` as `true` speeds up merging via the platform's native automerge functionality. @@ -4065,7 +4065,7 @@ This way Renovate can use GitHub's [Commit signing support for bots and other Gi !!! note - When using platform commits, GitHub determines the git author string to use and Renovate's own gitAuthor is ignored. + When using platform commits, GitHub determines the git author string to use and Renovate's own gitAuthor is ignored. ## `postUpdateOptions` @@ -4127,7 +4127,7 @@ They will be compiled _prior_ to the comparison against [`allowedCommands`](./se !!! note - Do not use `git add` in your commands to add new files to be tracked, add them by including them in your [`postUpgradeTasks.fileFilters`](#postupgradetasksfilefilters) instead. + Do not use `git add` in your commands to add new files to be tracked, add them by including them in your [`postUpgradeTasks.fileFilters`](#postupgradetasksfilefilters) instead. ### `postUpgradeTasks.dataFileTemplate` @@ -4177,7 +4177,7 @@ The possible tool names that are known by [Containerbase](https://github.com/con !!! note - When using [`binarySource=global`](./self-hosted-configuration.md#binarysource), the `installTools` options do not take effect. + When using [`binarySource=global`](./self-hosted-configuration.md#binarysource), the `installTools` options do not take effect. For example: @@ -4208,7 +4208,7 @@ For example: !!! note - The tool objects inside `installTools` currently do not expose any additional configurability. + The tool objects inside `installTools` currently do not expose any additional configurability. ### `postUpgradeTasks.workingDirTemplate` @@ -4243,7 +4243,7 @@ Use this array to provide a list of column names you wish to include in the PR t !!! note - "Package file" is predefined in the default `prBodyDefinitions` object so does not require a definition before it can be used. + "Package file" is predefined in the default `prBodyDefinitions` object so does not require a definition before it can be used. ## `prBodyDefinitions` @@ -4277,7 +4277,7 @@ You can configure this object to either: !!! tip - Columns must also be included in the `prBodyColumns` array in order to be used, so that's why it's included above in the example. + Columns must also be included in the `prBodyColumns` array in order to be used, so that's why it's included above in the example. ## `prBodyHeadingDefinitions` @@ -4296,11 +4296,11 @@ This can include Markdown or any other syntax that the platform supports. !!! tip - Columns must also be included in the `prBodyColumns` array in order to be used, so that's why it's included above in the example. + Columns must also be included in the `prBodyColumns` array in order to be used, so that's why it's included above in the example. !!! note - Templating is not supported for this option. + Templating is not supported for this option. ## `prBodyNotes` @@ -4333,8 +4333,8 @@ This limit is enforced on a per-repository basis. !!! note - Renovate always creates security PRs, even if the concurrent PR limit is already reached. - Security PRs have `[SECURITY]` in their PR title. + Renovate always creates security PRs, even if the concurrent PR limit is already reached. + Security PRs have `[SECURITY]` in their PR title. ## `prCreation` @@ -4360,12 +4360,12 @@ Renovate still creates the _branch_ immediately. !!! note - For all cases of non-immediate PR creation, Renovate doesn't run instantly once tests complete. - Instead, Renovate create the PR on its _next_ run after the relevant tests have completed, so there will be some delay. + For all cases of non-immediate PR creation, Renovate doesn't run instantly once tests complete. + Instead, Renovate create the PR on its _next_ run after the relevant tests have completed, so there will be some delay. !!! warning - If you set `prCreation=approval` you must _not_ use `dependencyDashboardApproval=true`! + If you set `prCreation=approval` you must _not_ use `dependencyDashboardApproval=true`! ## `prFooter` @@ -4396,8 +4396,8 @@ Now you can merge the PRs at a do-able rate, once the tests pass. !!! tip - The `prHourlyLimit` setting does _not_ limit the number of _concurrently open PRs_, only the _rate_ at which PRs are created. - The `prHourlyLimit` setting is enforced on a per-repository basis. + The `prHourlyLimit` setting does _not_ limit the number of _concurrently open PRs_, only the _rate_ at which PRs are created. + The `prHourlyLimit` setting is enforced on a per-repository basis. ## `prNotPendingHours` @@ -4407,7 +4407,7 @@ This is why we configured an upper limit for how long we wait until creating a P !!! note - If the option `minimumReleaseAge` is non-zero then Renovate disables the `prNotPendingHours` functionality. + If the option `minimumReleaseAge` is non-zero then Renovate disables the `prNotPendingHours` functionality. ## `prTitle` @@ -4622,9 +4622,9 @@ By default, `renovate` will update to a version greater than `latest` only if th !!! note - By default, respectLatest will be set to `false` for Maven results if a `latest` tag is found. - This is because many Maven registries don't have a reliable `latest` tag - it just means whatever was last published. - You need to override this to `respectLatest=true` in `packageRules` in order to use it. + By default, respectLatest will be set to `false` for Maven results if a `latest` tag is found. + This is because many Maven registries don't have a reliable `latest` tag - it just means whatever was last published. + You need to override this to `respectLatest=true` in `packageRules` in order to use it. ## `reviewers` @@ -4668,8 +4668,8 @@ Please note that Reviewers are only added during creation of a PR, but are not m !!! note - By default, Renovate will not assign reviewers and assignees to an automerge-enabled PR unless it fails status checks. - By configuring [`assignAutomerge`](#assignautomerge) setting to `true`, Renovate will instead always assign reviewers and assignees for automerging PRs at time of creation. + By default, Renovate will not assign reviewers and assignees to an automerge-enabled PR unless it fails status checks. + By configuring [`assignAutomerge`](#assignautomerge) setting to `true`, Renovate will instead always assign reviewers and assignees for automerging PRs at time of creation. ## `reviewersFromCodeOwners` @@ -4732,8 +4732,8 @@ Here are some example schedules and their Cron equivalent: !!! note - For Cron schedules, you _must_ use the `*` wildcard for the minutes value, as Renovate doesn't support minute granularity. - And the cron schedule must have five comma separated parts. + For Cron schedules, you _must_ use the `*` wildcard for the minutes value, as Renovate doesn't support minute granularity. + And the cron schedule must have five comma separated parts. One example might be that you don't want Renovate to run during your typical business hours, so that your build machines don't get clogged up testing `package.json` updates. You could then configure a schedule like this at the repository level: @@ -4750,8 +4750,8 @@ Note how the above example makes use of the "OR" logic of combining multiple sch !!! note - If both the day of the week _and_ the day of the month are restricted in the schedule, then Renovate only runs when both the day of the month _and_ day of the week match! - For example: `* * 1-7 * 4` means Renovate only runs on the _first_ Thursday of the month. + If both the day of the week _and_ the day of the month are restricted in the schedule, then Renovate only runs when both the day of the month _and_ day of the week match! + For example: `* * 1-7 * 4` means Renovate only runs on the _first_ Thursday of the month. It's common to use `schedule` in combination with [`timezone`](#timezone). You should configure [`updateNotScheduled=false`](#updatenotscheduled) if you want the schedule more strictly enforced so that _updates_ to existing branches aren't pushed out of schedule. @@ -4833,7 +4833,7 @@ When this option is set, Renovate won't attempt to update artifacts such as lock !!! note - When this option is used in package rules, along with grouped upgrades, artifact updating will only be skipped if every upgrade in the grouped branch wants to skip it. + When this option is used in package rules, along with grouped upgrades, artifact updating will only be skipped if every upgrade in the grouped branch wants to skip it. !!!warning @@ -4910,12 +4910,12 @@ This option can be used on the repository level and in the [Renovate configurati !!! note - The JVM memory settings specified in the global self-hosted configuration set by the administrator in [`toolSettings.jvmMaxMemory`](./self-hosted-configuration.md) limits the memory settings for all repositories. - The default limit for all repositories is 512m. + The JVM memory settings specified in the global self-hosted configuration set by the administrator in [`toolSettings.jvmMaxMemory`](./self-hosted-configuration.md) limits the memory settings for all repositories. + The default limit for all repositories is 512m. !!! note - The JVM memory settings are considered for the `gradle` and `gradle-wrapper` manager. + The JVM memory settings are considered for the `gradle` and `gradle-wrapper` manager. ### `toolSettings.jvmMaxMemory` @@ -4933,7 +4933,7 @@ Defaults to `jvmMaxMemory`. !!! note - This does not apply to _every_ Node process created by Renovate, only the managers noted above. + This does not apply to _every_ Node process created by Renovate, only the managers noted above. ## `updateInternalDeps` @@ -5105,14 +5105,14 @@ You may use the `vulnerabilityAlerts` configuration object to customize vulnerab !!! warning - There's a small chance that a wrong vulnerability alert results in a flapping/looping vulnerability fix. - If you allow Renovate to `automerge` vulnerability fixes, please check if the automerged fix is correct. + There's a small chance that a wrong vulnerability alert results in a flapping/looping vulnerability fix. + If you allow Renovate to `automerge` vulnerability fixes, please check if the automerged fix is correct. !!! note - When Renovate creates a `vulnerabilityAlerts` PR, it ignores settings like `branchConcurrentLimit`, `commitHourlyLimit`, `prConcurrentLimit`, `prHourlyLimit`, or `schedule`. - This means that Renovate _always_ tries to create a `vulnerabilityAlerts` PR. - In short: vulnerability alerts "skip the line". + When Renovate creates a `vulnerabilityAlerts` PR, it ignores settings like `branchConcurrentLimit`, `commitHourlyLimit`, `prConcurrentLimit`, `prHourlyLimit`, or `schedule`. + This means that Renovate _always_ tries to create a `vulnerabilityAlerts` PR. + In short: vulnerability alerts "skip the line". To disable the vulnerability alerts feature, set `enabled=false` in a `vulnerabilityAlerts` config object, like this: @@ -5126,7 +5126,7 @@ To disable the vulnerability alerts feature, set `enabled=false` in a `vulnerabi !!! note - If you want to raise only vulnerability fix PRs, you may use the `security:only-security-updates` preset. + If you want to raise only vulnerability fix PRs, you may use the `security:only-security-updates` preset. ### `vulnerabilityAlerts.vulnerabilityFixStrategy` diff --git a/docs/usage/dependency-pinning.md b/docs/usage/dependency-pinning.md index 0532706b47..89d9c9a186 100644 --- a/docs/usage/dependency-pinning.md +++ b/docs/usage/dependency-pinning.md @@ -55,7 +55,7 @@ This benefits when upgrading versions as well as when rolling back in case of pr !!! note - We'll cover lock files later, don't worry. + We'll cover lock files later, don't worry. ### Upgrading pinned versions diff --git a/docs/usage/docker-build-process.md b/docs/usage/docker-build-process.md index abc444e0ff..8bf5ec6d03 100644 --- a/docs/usage/docker-build-process.md +++ b/docs/usage/docker-build-process.md @@ -57,7 +57,7 @@ If you, as a user, are looking to extend the tool support that Renovate has, for !!! note - In the future, there will be a [clearer guide](https://github.com/containerbase/base/issues/6570) for how to contribute tool support as a user. + In the future, there will be a [clearer guide](https://github.com/containerbase/base/issues/6570) for how to contribute tool support as a user. This tool will have its support added in `containerbase/base`, to allow Containerbase's `install-tool` command-line tool to install the tool. @@ -71,7 +71,7 @@ To add it to the default images, the [`renovatebot/base-image` image](https://gi !!! note - Installed-by-default-tools will generally only be allowed for the "full" image. + Installed-by-default-tools will generally only be allowed for the "full" image. ## Building the Docker image locally diff --git a/docs/usage/docker.md b/docs/usage/docker.md index 07370116e1..cdefbbf6b9 100644 --- a/docs/usage/docker.md +++ b/docs/usage/docker.md @@ -200,19 +200,19 @@ Add `"default:pinDigestsDisabled"` to your `extends` array. !!! note - This preset only sets the global default for the [digest pinning flag](./configuration-options.md#pindigests) to `false`. - If you have configured package rules that set `pinDigests` to `true`, those will still apply. - This is also the case if you use the [`docker:pinDigests` preset](./presets-docker.md#dockerpindigests), which adds a package rule that sets `pinDigests` to `true` for all packages from the docker datasource. + This preset only sets the global default for the [digest pinning flag](./configuration-options.md#pindigests) to `false`. + If you have configured package rules that set `pinDigests` to `true`, those will still apply. + This is also the case if you use the [`docker:pinDigests` preset](./presets-docker.md#dockerpindigests), which adds a package rule that sets `pinDigests` to `true` for all packages from the docker datasource. - If you want to disable the `docker:pinDigests` preset (e.g. if you want to use `config:best-practices` but not have digest pinning enabled), - ignore the preset like this: +If you want to disable the `docker:pinDigests` preset (e.g. if you want to use `config:best-practices` but not have digest pinning enabled), +ignore the preset like this: - ```json - { - "extends": ["config:best-practices"], - "ignorePresets": ["docker:pinDigests"] - } - ``` +```json +{ + "extends": ["config:best-practices"], + "ignorePresets": ["docker:pinDigests"] +} +``` diff --git a/docs/usage/examples/self-hosting.md b/docs/usage/examples/self-hosting.md index 14130c2a9e..cf9ccb874d 100644 --- a/docs/usage/examples/self-hosting.md +++ b/docs/usage/examples/self-hosting.md @@ -2,14 +2,14 @@ !!! warning - All self-hosted Renovate instances must operate under a trust relationship with the developers of the monitored repositories. Because of this, there are [security implications](../security-and-permissions.md#security-awareness-for-self-hosted-renovate-instances) when running a self-hosted Renovate instance, which you must consider carefully. + All self-hosted Renovate instances must operate under a trust relationship with the developers of the monitored repositories. Because of this, there are [security implications](../security-and-permissions.md#security-awareness-for-self-hosted-renovate-instances) when running a self-hosted Renovate instance, which you must consider carefully. !!! warning - Most Open Source packages are hosted on github.com, including a number of tools that Renovate may pull at run-time. - GitHub greatly rate limits unauthenticated API requests, so you need to configure credentials for `github.com` or the bot will get rate limited quickly. -   - Read [Running Renovate, GitHub.com token for changelogs](../getting-started/running.md#githubcom-token-for-changelogs-and-tools) to learn more. + Most Open Source packages are hosted on github.com, including a number of tools that Renovate may pull at run-time. + GitHub greatly rate limits unauthenticated API requests, so you need to configure credentials for `github.com` or the bot will get rate limited quickly. +   + Read [Running Renovate, GitHub.com token for changelogs](../getting-started/running.md#githubcom-token-for-changelogs-and-tools) to learn more. ## Installing Renovate OSS CLI @@ -42,8 +42,8 @@ docker run --rm renovate/renovate:43.195.2 !!! warning - Do not use the example tags listed above, as they will be out-of-date. - Go to [the `renovate/renovate` tags on DockerHub](https://hub.docker.com/r/renovate/renovate/tags) to grab the latest tagged release from Renovate. + Do not use the example tags listed above, as they will be out-of-date. + Go to [the `renovate/renovate` tags on DockerHub](https://hub.docker.com/r/renovate/renovate/tags) to grab the latest tagged release from Renovate. If you want to configure Renovate using a `config.js` file then map it to `/usr/src/app/config.js` using Docker volumes. For example: @@ -165,9 +165,9 @@ spec: !!! warning - The CircleCI configuration examples are for version `2` of `daniel-shuy/renovate`, which is outdated. - Do you know how to get `daniel-shuy/renovate` version `3` working? - Then please open a pull request to update the docs and close [Renovate issue #13428](https://github.com/renovatebot/renovate/issues/13428). + The CircleCI configuration examples are for version `2` of `daniel-shuy/renovate`, which is outdated. + Do you know how to get `daniel-shuy/renovate` version `3` working? + Then please open a pull request to update the docs and close [Renovate issue #13428](https://github.com/renovatebot/renovate/issues/13428). If you are using CircleCI, you can use the third-party [daniel-shuy/renovate](https://circleci.com/developer/orbs/orb/daniel-shuy/renovate) orb to run a self-hosted instance of Renovate on CircleCI. @@ -285,8 +285,8 @@ Only add the script to `cron` after you checked it works. !!! note - The GitHub.com token as an environment variable is needed to fetch changelogs that are usually hosted on github.com. - You don't need to add it if you are already running the bot against github.com, but you do need to add it if you're using GitHub Enterprise Server, GitLab, Azure DevOps, or Bitbucket. + The GitHub.com token as an environment variable is needed to fetch changelogs that are usually hosted on github.com. + You don't need to add it if you are already running the bot against github.com, but you do need to add it if you're using GitHub Enterprise Server, GitLab, Azure DevOps, or Bitbucket. ## Kubernetes for GitLab, using Git over SSH diff --git a/docs/usage/getting-started/installing-onboarding.md b/docs/usage/getting-started/installing-onboarding.md index c35a6db843..3dbdc053f1 100644 --- a/docs/usage/getting-started/installing-onboarding.md +++ b/docs/usage/getting-started/installing-onboarding.md @@ -41,8 +41,8 @@ Once you're done selecting repositories for Renovate to run on, select the green !!! note - If you are using the Mend Renovate App then it has a custom behavior for forked repositories. - If you choose "All repositories" when installing then forked repositories will be skipped by default, while if you choose "Select repositories" then they will be processed by Renovate even if they're a fork. + If you are using the Mend Renovate App then it has a custom behavior for forked repositories. + If you choose "All repositories" when installing then forked repositories will be skipped by default, while if you choose "Select repositories" then they will be processed by Renovate even if they're a fork. ### Hosted GitLab.com App @@ -69,7 +69,7 @@ Once you have enabled Renovate on a repository, you will get a "Configure Renova !!! note - If you self-host Renovate, and want to add the rebase/retry checkbox to Renovate's onboarding PRs: enable the [`onboardingRebaseCheckbox` config option](../self-hosted-configuration.md#onboardingrebasecheckbox) first. + If you self-host Renovate, and want to add the rebase/retry checkbox to Renovate's onboarding PRs: enable the [`onboardingRebaseCheckbox` config option](../self-hosted-configuration.md#onboardingrebasecheckbox) first. ### No risk onboarding @@ -108,7 +108,7 @@ The bot first checks all the files in the `configFileNames` array before checkin !!! warning - This approach has been deprecated and will be removed in a future release. + This approach has been deprecated and will be removed in a future release. You can add the same settings to a `"renovate"` section in your `package.json` file instead. The `package.json` file must be located at the root of your repository. diff --git a/docs/usage/getting-started/private-packages.md b/docs/usage/getting-started/private-packages.md index 885d8c406e..6f79a5c845 100644 --- a/docs/usage/getting-started/private-packages.md +++ b/docs/usage/getting-started/private-packages.md @@ -25,7 +25,7 @@ There are four times in Renovate's behavior when it may need credentials: !!! note - If you self-host Renovate, and have a self-hosted registry which _doesn't_ require authentication to access, then such modules/packages are not considered "private" to Renovate. + If you self-host Renovate, and have a self-hosted registry which _doesn't_ require authentication to access, then such modules/packages are not considered "private" to Renovate. ## Private Config Presets @@ -158,7 +158,7 @@ Currently the preferred way to configure `github.com` credentials for self-hoste !!! note - `GITHUB_COM_TOKEN` is still parsed and takes precedence over `RENOVATE_GITHUB_COM_TOKEN`, but is considered deprecated and will be removed in a future major update. + `GITHUB_COM_TOKEN` is still parsed and takes precedence over `RENOVATE_GITHUB_COM_TOKEN`, but is considered deprecated and will be removed in a future major update. ## Package Manager Credentials for Artifact Updating @@ -272,7 +272,7 @@ module.exports = { !!! tip - Remember to put a trailing slash at the end of your `matchHost` URL. + Remember to put a trailing slash at the end of your `matchHost` URL. #### Add npmrc string to Renovate config @@ -479,8 +479,8 @@ Then Renovate passes the information to `pip-compile` via environment variables. !!! warning "Put directives in the .in file, avoid the lockfile" - You must put the `--[extra-]index-url` directive(s) in the `.in` file, for `pip-compile` to use during Renovate jobs. - Do _not_ put the directive(s) in the lockfile, as this is _not_ supported. + You must put the `--[extra-]index-url` directive(s) in the `.in` file, for `pip-compile` to use during Renovate jobs. + Do _not_ put the directive(s) in the lockfile, as this is _not_ supported. ```title="requirements.in" --extra-index-url https://pypi.my.domain/simple @@ -593,10 +593,10 @@ The preferred approach to secrets is that the bot administrator configures them !!! warning "Store secrets for your Mend-hosted app via the web UI" - Mend no longer supports putting encrypted secrets in the Renovate config file on your repository. - Going forward, all secrets must be stored in the App settings via the web UI. - If you have encrypted secrets in your Renovate config, you must migrate them to the web UI. - Read [Migrating Secrets from Repo Config to App Settings](../mend-hosted/migrating-secrets.md) to learn how. + Mend no longer supports putting encrypted secrets in the Renovate config file on your repository. + Going forward, all secrets must be stored in the App settings via the web UI. + If you have encrypted secrets in your Renovate config, you must migrate them to the web UI. + Read [Migrating Secrets from Repo Config to App Settings](../mend-hosted/migrating-secrets.md) to learn how. If you need to provide credentials to the Mend Renovate App, please do this: @@ -644,7 +644,7 @@ For instructions on this, see the above section on encrypting secrets for the Me !!! note - Encrypted values can't be used in the "Admin/Bot config". + Encrypted values can't be used in the "Admin/Bot config". ### hostRules configuration using environment variables diff --git a/docs/usage/getting-started/running.md b/docs/usage/getting-started/running.md index 337fc110e1..fdf5dfc557 100644 --- a/docs/usage/getting-started/running.md +++ b/docs/usage/getting-started/running.md @@ -59,7 +59,7 @@ Use the [`containerbaseDir` config option](../self-hosted-configuration.md#conta !!! warning - The usage of `binarySource=docker` is deprecated, and [will be removed in the future](https://github.com/renovatebot/renovate/issues/40747). + The usage of `binarySource=docker` is deprecated, and [will be removed in the future](https://github.com/renovatebot/renovate/issues/40747). If you want, you can map the Docker socket into the container so that Renovate can dynamically invoke "sidecar" images when needed. You'll need to set `binarySource=docker` for this to work. @@ -178,8 +178,8 @@ If you combine both of the above then any single config option in the environmen !!! note - It's also possible to change the default prefix from `RENOVATE_` using `ENV_PREFIX`. - For example: `ENV_PREFIX=RNV_ RNV_TOKEN=abc123 renovate`. + It's also possible to change the default prefix from `RENOVATE_` using `ENV_PREFIX`. + For example: `ENV_PREFIX=RNV_ RNV_TOKEN=abc123 renovate`. #### Using `config.js` @@ -230,8 +230,8 @@ We also recommend you configure `config.gitAuthor` with the same identity as you !!! warning - We recommend you use a single, dedicated username for your Renovate bot. - Never share the Renovate username with your other bots, as this can cause flip-flopping. + We recommend you use a single, dedicated username for your Renovate bot. + Never share the Renovate username with your other bots, as this can cause flip-flopping. #### Docs @@ -255,8 +255,8 @@ It's also OK to configure the same as a host rule instead, if you prefer that. !!! note - If you're using Renovate in a project where dependencies are loaded from github.com (such as Go modules hosted on GitHub), we highly recommend that you add a `github.com` PAT (classic). - Otherwise you will exceed the rate limit for the github.com API, which will lead to Renovate closing and reopening PRs because it could not get reliable info on updated dependencies. + If you're using Renovate in a project where dependencies are loaded from github.com (such as Go modules hosted on GitHub), we highly recommend that you add a `github.com` PAT (classic). + Otherwise you will exceed the rate limit for the github.com API, which will lead to Renovate closing and reopening PRs because it could not get reliable info on updated dependencies. ### Self-hosting examples diff --git a/docs/usage/gitlab-bot-security.md b/docs/usage/gitlab-bot-security.md index 1fd31351cc..bc253661c9 100644 --- a/docs/usage/gitlab-bot-security.md +++ b/docs/usage/gitlab-bot-security.md @@ -8,7 +8,7 @@ Make sure you understand GitLab's security model, before you run a "bot" service !!! warning - If you have any doubts or concerns about this content that could affect other users, please follow our [Security Policy](https://github.com/renovatebot/renovate/security/policy) and report them confidentially. + If you have any doubts or concerns about this content that could affect other users, please follow our [Security Policy](https://github.com/renovatebot/renovate/security/policy) and report them confidentially. ## `CI_JOB_TOKEN` permissions diff --git a/docs/usage/golang.md b/docs/usage/golang.md index 4394a5f4dc..524621bbb0 100644 --- a/docs/usage/golang.md +++ b/docs/usage/golang.md @@ -58,8 +58,8 @@ Renovate will commit all files changed within the `vendor/` folder. !!! note - Renovate does not support vendoring major upgrades of Go modules. - Follow issue [#21010](https://github.com/renovatebot/renovate/issues/21010). + Renovate does not support vendoring major upgrades of Go modules. + Follow issue [#21010](https://github.com/renovatebot/renovate/issues/21010). ### Go binary version diff --git a/docs/usage/index.md b/docs/usage/index.md index c29bf8ac20..85377e2f9c 100644 --- a/docs/usage/index.md +++ b/docs/usage/index.md @@ -14,45 +14,45 @@ Multi-platform and multi-language. - :octicons-git-pull-request-24:{ .lg .middle } __Automatic updates__ - --- + --- - Get pull requests to update your dependencies and lock files. + Get pull requests to update your dependencies and lock files. - :octicons-calendar-24:{ .lg .middle } __On your schedule__ - --- + --- - Reduce noise by scheduling when Renovate creates PRs. + Reduce noise by scheduling when Renovate creates PRs. - :octicons-package-24:{ .lg .middle } __Works out of the box__ - --- + --- - Renovate finds relevant package files automatically, including in monorepos. + Renovate finds relevant package files automatically, including in monorepos. - :octicons-goal-24:{ .lg .middle } __How you like it__ - --- + --- - You can customize the bot's behavior with configuration files. + You can customize the bot's behavior with configuration files. - :octicons-share-24:{ .lg .middle } __Share your configuration__ - --- + --- - Share your configuration with ESLint-like config presets. + Share your configuration with ESLint-like config presets. - :octicons-sync-24:{ .lg .middle } __Out with the old, in with the new__ - --- + --- - Get replacement PRs to migrate from a deprecated dependency to the community suggested replacement, works with _most_ managers, see [issue 14149](https://github.com/renovatebot/renovate/issues/14149) for exceptions. + Get replacement PRs to migrate from a deprecated dependency to the community suggested replacement, works with _most_ managers, see [issue 14149](https://github.com/renovatebot/renovate/issues/14149) for exceptions. - :octicons-tools-24:{ .lg .middle } __Open source__ - --- + --- - Renovate is licensed under the [GNU Affero General Public License](https://github.com/renovatebot/renovate/blob/main/license) (`AGPL-3.0-only`). + Renovate is licensed under the [GNU Affero General Public License](https://github.com/renovatebot/renovate/blob/main/license) (`AGPL-3.0-only`). diff --git a/docs/usage/json-schema.md b/docs/usage/json-schema.md index 55df11e42d..98830bcea8 100644 --- a/docs/usage/json-schema.md +++ b/docs/usage/json-schema.md @@ -72,6 +72,6 @@ With this in mind, when Renovate releases a major version, we store an archive o !!! note - Previous major versions are only available since Renovate 39 (2025-04-29). + Previous major versions are only available since Renovate 39 (2025-04-29). For instance, if you are running Renovate 41, you will be able to use i.e. [`www.schemastore.org/renovate-41.json`](https://www.schemastore.org/renovate-41.json) for your JSON Schema. diff --git a/docs/usage/key-concepts/automerge.md b/docs/usage/key-concepts/automerge.md index 216604ea0a..4df0284043 100644 --- a/docs/usage/key-concepts/automerge.md +++ b/docs/usage/key-concepts/automerge.md @@ -135,9 +135,9 @@ The steps to enable GitHub's Merge Queue differ based on whether you use GitHub !!! tip "GitHub Merge Queue overview page" - GitHub has a page that shows all the PRs in the Merge Queue. - The page link follows this pattern: `https://github.com/organization-name/repository-name/queue/base-branch-name`. - For example, here's [Renovate's main repository's Merge Queue overview](https://github.com/renovatebot/renovate/queue/main). + GitHub has a page that shows all the PRs in the Merge Queue. + The page link follows this pattern: `https://github.com/organization-name/repository-name/queue/base-branch-name`. + For example, here's [Renovate's main repository's Merge Queue overview](https://github.com/renovatebot/renovate/queue/main). #### If you use GitHub Actions @@ -234,7 +234,7 @@ If you have no tests but still want Renovate to automerge, you need to add `"ign !!! tip - We strongly recommend you have tests in any project where you are regularly updating dependencies. + We strongly recommend you have tests in any project where you are regularly updating dependencies. ### Committer restrictions diff --git a/docs/usage/key-concepts/minimum-release-age.md b/docs/usage/key-concepts/minimum-release-age.md index e7bb50096a..cd6ad0d879 100644 --- a/docs/usage/key-concepts/minimum-release-age.md +++ b/docs/usage/key-concepts/minimum-release-age.md @@ -64,20 +64,18 @@ After the next lock file maintenance run (which regenerates the lock file from s !!! warning - Renovate 42 changed the behaviour detailed below. - In Renovate 42, the absence of a release timestamp will be treated as if the release is not yet past the timestamp, which provides a safer default. - Prior to Renovate 42, we would treat the dependency without a release timestamp **as if it has passed** the `minimumReleaseAge`, and will **immediately suggest that dependency update**. - If using Renovate prior you can opt into the more secure behaviour (which is default in Renovate 42) by using [`minimumReleaseAgeBehaviour=timestamp-required`](../configuration-options.md#minimumreleaseagebehaviour) (added in 41.150.0) + Renovate 42 changed the behaviour detailed below. + In Renovate 42, the absence of a release timestamp will be treated as if the release is not yet past the timestamp, which provides a safer default. + Prior to Renovate 42, we would treat the dependency without a release timestamp **as if it has passed** the `minimumReleaseAge`, and will **immediately suggest that dependency update**. + If using Renovate prior you can opt into the more secure behaviour (which is default in Renovate 42) by using [`minimumReleaseAgeBehaviour=timestamp-required`](../configuration-options.md#minimumreleaseagebehaviour) (added in 41.150.0) Consider that: - - - we have set `minimumReleaseAge` to apply to a given dependency - that dependency has 4 updates available - - 1 of which has a release timestamp that has passed - - 2 of which have a release timestamp that has _not_ yet passed - - 1 of which does not have a release timestamp + - 1 of which has a release timestamp that has passed + - 2 of which have a release timestamp that has _not_ yet passed + - 1 of which does not have a release timestamp Renovate will create a PR for the 1 dependency update that has passed the release timestamp, and the others will be marked as "Pending Status Checks" on the Dependency Dashboard. As time goes on, if the 2 updates with a release timestamp are now passed the minimum release age, Renovate will add them to the PR (or create a new one). @@ -110,7 +108,7 @@ You can force the dependency update by requesting it via the Dependency Dashboar !!! note - A previous version of the documentation (up until Renovate 42.19.9) recommended configuring [`prCreation`](../configuration-options.md#prcreation). This is no longer the case. + A previous version of the documentation (up until Renovate 42.19.9) recommended configuring [`prCreation`](../configuration-options.md#prcreation). This is no longer the case. If no branch is created, Renovate will not raise a PR, regardless of [`prCreation`](../configuration-options.md#prcreation)'s settings. @@ -148,7 +146,7 @@ Security updates bypass any `minimumReleaseAge` checks, and so will be raised as !!! note - This is based on the [recommended settings above](#recommended-settings) + This is based on the [recommended settings above](#recommended-settings) Renovate waits for the set duration to pass for each **separate** version. @@ -192,13 +190,13 @@ To opt out a dependency from minimum release age checks, create a package rule w !!! note - As of Renovate 42.19.5, using `minimumReleaseAge=0 days` is treated the same as `minimumReleaseAge=null`. + As of Renovate 42.19.5, using `minimumReleaseAge=0 days` is treated the same as `minimumReleaseAge=null`. ### Which datasources support release timestamps? !!! tip - You can confirm if your datasource supports the release timestamp by viewing [the documentation for the given datasource](../modules/datasource/index.md). + You can confirm if your datasource supports the release timestamp by viewing [the documentation for the given datasource](../modules/datasource/index.md). The datasource that Renovate uses must have a release timestamp for the `minimumReleaseAge` config option to work. Some datasources may have a release timestamp, but in a format Renovate does not support. diff --git a/docs/usage/key-concepts/presets.md b/docs/usage/key-concepts/presets.md index 879332d8e1..afcc244c3d 100644 --- a/docs/usage/key-concepts/presets.md +++ b/docs/usage/key-concepts/presets.md @@ -35,7 +35,7 @@ In the example above, Renovate follows the rules from the `config:recommended` p !!! tip - If there is a logical conflict between presets, then the _last_ preset in the `"extends"` array "wins". + If there is a logical conflict between presets, then the _last_ preset in the `"extends"` array "wins". ## Managing config for many repositories diff --git a/docs/usage/key-concepts/pull-requests.md b/docs/usage/key-concepts/pull-requests.md index 456f3566f5..61624d114c 100644 --- a/docs/usage/key-concepts/pull-requests.md +++ b/docs/usage/key-concepts/pull-requests.md @@ -89,6 +89,6 @@ Close a Renovate PR to ignore it. !!! note - Renovate re-creates any PRs that are marked "immortal". - This means that any immortal PR you close, pops up again the next time Renovate runs. - To ignore immortal PRs, follow the advice in the [How to fix immortal PRs](#how-to-fix-immortal-prs) section. + Renovate re-creates any PRs that are marked "immortal". + This means that any immortal PR you close, pops up again the next time Renovate runs. + To ignore immortal PRs, follow the advice in the [How to fix immortal PRs](#how-to-fix-immortal-prs) section. diff --git a/docs/usage/key-concepts/scheduling.md b/docs/usage/key-concepts/scheduling.md index 5e938af19e..557414ff5b 100644 --- a/docs/usage/key-concepts/scheduling.md +++ b/docs/usage/key-concepts/scheduling.md @@ -109,8 +109,8 @@ We recommend you use the `cron` syntax in your Renovate schedules. !!! note - For Cron schedules, you _must_ use the `*` wildcard for the minutes value, as Renovate doesn't support minute granularity. - And the cron schedule must have five parts. + For Cron schedules, you _must_ use the `*` wildcard for the minutes value, as Renovate doesn't support minute granularity. + And the cron schedule must have five parts. #### Deprecated breejs/later syntax @@ -133,8 +133,8 @@ The `@breejs/later` library also controls the interpretation of "days", time_bef !!! warning - Renovate does _not_ support scheduled minutes or "at an exact time" granularity. - Granularity must be at least one hour. + Renovate does _not_ support scheduled minutes or "at an exact time" granularity. + Granularity must be at least one hour. ### In-repository schedule configuration diff --git a/docs/usage/mend-hosted/faq.md b/docs/usage/mend-hosted/faq.md index 1c61194b41..227daa7a31 100644 --- a/docs/usage/mend-hosted/faq.md +++ b/docs/usage/mend-hosted/faq.md @@ -12,7 +12,7 @@ It is recommended to set this between 1.5GB and 2.5GB but may require tweaking a !!! note - It is at the discretion of Mend to raise the memory limit for repositories, in a similar way to how [there are increased resources for Open Source projects on Renovate Cloud](https://github.com/renovatebot/renovate/discussions/33617). + It is at the discretion of Mend to raise the memory limit for repositories, in a similar way to how [there are increased resources for Open Source projects on Renovate Cloud](https://github.com/renovatebot/renovate/discussions/33617). ## What IP Addresses are used by Mend Renovate Cloud? diff --git a/docs/usage/mend-hosted/hosted-apps-config.md b/docs/usage/mend-hosted/hosted-apps-config.md index 6c40decfec..bdc2bf8931 100644 --- a/docs/usage/mend-hosted/hosted-apps-config.md +++ b/docs/usage/mend-hosted/hosted-apps-config.md @@ -7,7 +7,7 @@ This page: !!! note - For general configuration of the Renovate CLI, read the main [Configuration/Overview](../config-overview.md) section. + For general configuration of the Renovate CLI, read the main [Configuration/Overview](../config-overview.md) section. ## Finding the logs @@ -48,7 +48,7 @@ Follow these steps to see which version the Mend Renovate app used for a specifi !!! tip - The PRs that Renovate creates have a link to the "repository job log" in the footer of the PR body text. + The PRs that Renovate creates have a link to the "repository job log" in the footer of the PR body text. ## Onboarding behavior @@ -117,13 +117,13 @@ As noted in [Validation of Renovate config change PRs](../config-validation.md#v !!! tip - When using a Mend-hosted app, the "reconfigure" branch defaults to `renovate/reconfigure`. + When using a Mend-hosted app, the "reconfigure" branch defaults to `renovate/reconfigure`. When pushing to this specific branch name, Renovate will run its validation and report a status check to the Platform whether this passes/fails validation. !!! note - The reconfigure branch **must** be pushed to the source repository that Renovate runs against, not a fork. + The reconfigure branch **must** be pushed to the source repository that Renovate runs against, not a fork. If you have a Pull Request open from this branch (including draft PRs), Renovate will comment on the PR to note: diff --git a/docs/usage/mend-hosted/overview.md b/docs/usage/mend-hosted/overview.md index 270de5009d..b1dd44ec16 100644 --- a/docs/usage/mend-hosted/overview.md +++ b/docs/usage/mend-hosted/overview.md @@ -46,9 +46,9 @@ Projects licensed under an Open Source Initiative (OSI) approved license can req !!! tip - To request increased resources, create a [Mend Hosted Request](https://github.com/renovatebot/renovate/discussions/new?category=mend-hosted-request) on the Renovate GitHub Discussions board. -
- Acceptance is at the discretion of Mend. + To request increased resources, create a [Mend Hosted Request](https://github.com/renovatebot/renovate/discussions/new?category=mend-hosted-request) on the Renovate GitHub Discussions board. +
+ Acceptance is at the discretion of Mend. ### Mend Renovate Enterprise Cloud diff --git a/docs/usage/merge-confidence.md b/docs/usage/merge-confidence.md index c268159713..6f6858aba7 100644 --- a/docs/usage/merge-confidence.md +++ b/docs/usage/merge-confidence.md @@ -53,7 +53,7 @@ If you're self-hosting Renovate, you can enable the badges by adding the `mergeC !!! note - The `mergeConfidence:age-confidence-badges` preset can be used to only show the Age and Confidence badges. + The `mergeConfidence:age-confidence-badges` preset can be used to only show the Age and Confidence badges. If you want to disable the badges in the Mend Renovate App, add the `mergeConfidence:all-badges` preset to the `ignorePresets` array in your config: diff --git a/docs/usage/nuget.md b/docs/usage/nuget.md index af37275a32..0171ac20aa 100644 --- a/docs/usage/nuget.md +++ b/docs/usage/nuget.md @@ -65,7 +65,7 @@ All feeds are checked for dependency updates, and duplicate updates are merged i !!! note - Some alternative feeds (e.g. Artifactory) do not implement the full set of [required NuGet resources](https://learn.microsoft.com/en-us/nuget/api/overview#resources-and-schema) for the V3 API. If the `PackageBaseAddress` resource does not exist, Renovate falls back to using the `projectUrl` from the dependency's catalog entry as the `sourceUrl` for the dependency, affecting [changelog detection](key-concepts/changelogs.md#how-renovate-detects-changelogs). + Some alternative feeds (e.g. Artifactory) do not implement the full set of [required NuGet resources](https://learn.microsoft.com/en-us/nuget/api/overview#resources-and-schema) for the V3 API. If the `PackageBaseAddress` resource does not exist, Renovate falls back to using the `projectUrl` from the dependency's catalog entry as the `sourceUrl` for the dependency, affecting [changelog detection](key-concepts/changelogs.md#how-renovate-detects-changelogs). ### Protocol versions @@ -129,10 +129,10 @@ If you use Azure DevOps: !!! note - Only Basic HTTP authentication (via username and password) is supported. - For Azure DevOps: use a PAT with `read` permissions on `Packaging`. - The username of the PAT must match the username of the _user of the PAT_. - The generated `nuget.config` forces the basic authentication, which cannot be overridden externally! + Only Basic HTTP authentication (via username and password) is supported. + For Azure DevOps: use a PAT with `read` permissions on `Packaging`. + The username of the PAT must match the username of the _user of the PAT_. + The generated `nuget.config` forces the basic authentication, which cannot be overridden externally! ## Ignoring package files when using presets diff --git a/docs/usage/opentelemetry.md b/docs/usage/opentelemetry.md index 1242583f0d..a14e63f00c 100644 --- a/docs/usage/opentelemetry.md +++ b/docs/usage/opentelemetry.md @@ -7,9 +7,9 @@ description: How to use OpenTelemetry with Renovate !!! warning "This feature is flagged as experimental" - Experimental features might be changed at any time. -

- Renovate's OpenTelemetry support is stable enough to use in production, but there may be changes that rename attributes or fix bugs in a breaking, even in non-major version updates. + Experimental features might be changed at any time. +

+ Renovate's OpenTelemetry support is stable enough to use in production, but there may be changes that rename attributes or fix bugs in a breaking, even in non-major version updates. Renovate supports the [OpenTelemetry](https://opentelemetry.io/) monitoring and observability standard. @@ -21,9 +21,9 @@ OpenTelemetry has three types of observability data it supports within the OpenT !!! note - While the OpenTelemetry Protocol (OTLP) support traces, metrics, and logs, Renovate only supports traces, and some metrics. -

- This means Renovate does not support other observability data like: stats on caching, error events, number of found updates, and so on. + While the OpenTelemetry Protocol (OTLP) support traces, metrics, and logs, Renovate only supports traces, and some metrics. +

+ This means Renovate does not support other observability data like: stats on caching, error events, number of found updates, and so on. Renovate uses [`@opentelemetry/exporter-trace-otlp-http`](https://www.npmjs.com/package/@opentelemetry/exporter-trace-otlp-http) under the hood. This means that Renovate sends traces via [OTLP/HTTP](https://opentelemetry.io/docs/reference/specification/protocol/otlp/#otlphttp) in JSON-encoded protobuf format only. diff --git a/docs/usage/python.md b/docs/usage/python.md index ed13f16683..3508593c58 100644 --- a/docs/usage/python.md +++ b/docs/usage/python.md @@ -76,9 +76,9 @@ Fill the array with alternate index URL(s). !!! tip - If a `requirements.txt` file has an index-url then Renovate follows that link, instead of following any link set in the `registryUrls` array. - To override the URL found in `requirements.txt`, you must create a custom `packageRules` setting. - This is because `packageRules` are applied _after_ package file extraction. + If a `requirements.txt` file has an index-url then Renovate follows that link, instead of following any link set in the `registryUrls` array. + To override the URL found in `requirements.txt`, you must create a custom `packageRules` setting. + This is because `packageRules` are applied _after_ package file extraction. ## Disabling Python support diff --git a/docs/usage/security-and-permissions.md b/docs/usage/security-and-permissions.md index 4ff15ffaaf..d3faba6df5 100644 --- a/docs/usage/security-and-permissions.md +++ b/docs/usage/security-and-permissions.md @@ -111,7 +111,7 @@ Separately, there are also opportunities for malicious external code to execute, !!! warning - Below are _some_ of the options, but note that this is **not exhaustive**. + Below are _some_ of the options, but note that this is **not exhaustive**. For instance: diff --git a/docs/usage/self-hosted-configuration.md b/docs/usage/self-hosted-configuration.md index 52f773b322..71d3b50147 100644 --- a/docs/usage/self-hosted-configuration.md +++ b/docs/usage/self-hosted-configuration.md @@ -13,19 +13,19 @@ The config options below _must_ be configured in the bot/admin config, so in eit !!! note - Renovate supports `JSONC` for `.json` files and any config files without file extension (e.g. `.renovaterc`). + Renovate supports `JSONC` for `.json` files and any config files without file extension (e.g. `.renovaterc`). For information about how to configure Renovate with a `config.js` see the [Using `config.js` documentation](./getting-started/running.md#using-configjs). !!! tip - This documentation corresponds with the JSON schema in [`docs.renovatebot.com/renovate-global-schema.json`](renovate-global-schema.json), and any [inherited config options](./config-overview.md#inherited-config) are also present in [`docs.renovatebot.com/renovate-inherited-schema.json`](renovate-inherited-schema.json). + This documentation corresponds with the JSON schema in [`docs.renovatebot.com/renovate-global-schema.json`](renovate-global-schema.json), and any [inherited config options](./config-overview.md#inherited-config) are also present in [`docs.renovatebot.com/renovate-inherited-schema.json`](renovate-inherited-schema.json). Please also see [Self-Hosted Experimental Options](./self-hosted-experimental.md). !!! note - Config options with `type=string` are always non-mergeable, so `mergeable=false`. + Config options with `type=string` are always non-mergeable, so `mergeable=false`. ## `allowCustomCrateRegistries` @@ -63,9 +63,9 @@ This will not affect calling a script like: !!! warning - This has the risk of arbitrary environment variable access or additional command execution. - It is very likely this will be susceptible to these risks, even if you allowlist (via `allowedCommands`), - as there may be special characters included in the given commands that can be leveraged + This has the risk of arbitrary environment variable access or additional command execution. + It is very likely this will be susceptible to these risks, even if you allowlist (via `allowedCommands`), + as there may be special characters included in the given commands that can be leveraged ## `allowedCommands` @@ -232,8 +232,8 @@ For example: !!! note - On Gitea/Forgejo, you can't use `autodiscoverTopics` together with `autodiscoverNamespaces` because both platforms do not support this. - Topics are preferred and `autodiscoverNamespaces` will be ignored when you configure `autodiscoverTopics` on Gitea/Forgejo. + On Gitea/Forgejo, you can't use `autodiscoverTopics` together with `autodiscoverNamespaces` because both platforms do not support this. + Topics are preferred and `autodiscoverNamespaces` will be ignored when you configure `autodiscoverTopics` on Gitea/Forgejo. ## `autodiscoverProjects` @@ -319,7 +319,7 @@ If you are building your own Renovate image, e.g. by installing Renovate using ` !!! warning - The usage of `binarySource=docker` is deprecated, and [will be removed in the future](https://github.com/renovatebot/renovate/issues/40747). + The usage of `binarySource=docker` is deprecated, and [will be removed in the future](https://github.com/renovatebot/renovate/issues/40747). We also have a deprecated `docker` mode. @@ -452,7 +452,7 @@ Example: !!! note - If you want renovate to use a custom filename for the onboarding branch you also need to change the [`onboardingConfigFileName`](#onboardingconfigfilename). + If you want renovate to use a custom filename for the onboarding branch you also need to change the [`onboardingConfigFileName`](#onboardingconfigfilename). ## `configValidationError` @@ -470,8 +470,8 @@ This configuration will be applied after all other environment variables so you !!! warning - Do not configure any secret values directly into `customEnvVariables` because they may be logged to stdout. - Instead, configure them into `secrets` first so that they will be redacted in logs. + Do not configure any secret values directly into `customEnvVariables` because they may be logged to stdout. + Instead, configure them into `secrets` first so that they will be redacted in logs. If configuring secrets in to `customEnvVariables`, take this approach: @@ -501,7 +501,7 @@ The process that runs Renovate must have the correct permissions to delete the a !!! tip - You can tell Renovate where to find your config file with the `RENOVATE_ADDITONAL_CONFIG_FILE` environment variable. + You can tell Renovate where to find your config file with the `RENOVATE_ADDITONAL_CONFIG_FILE` environment variable. ## `deleteConfigFile` @@ -511,7 +511,7 @@ The process that runs Renovate must have the correct permissions to delete the c !!! tip - You can tell Renovate where to find your config file with the `RENOVATE_CONFIG_FILE` environment variable. + You can tell Renovate where to find your config file with the `RENOVATE_CONFIG_FILE` environment variable. ## `detectGlobalManagerConfig` @@ -538,8 +538,8 @@ Periods (`.`) in host names must be replaced with a single underscore (`_`). !!! note - You can't use these prefixes with the `detectHostRulesFromEnv` config option: `npm_config_`, `npm_lifecycle_`, `npm_package_`. - In addition, platform host rules will only be picked up when `matchHost` is supplied. + You can't use these prefixes with the `detectHostRulesFromEnv` config option: `npm_config_`, `npm_lifecycle_`, `npm_package_`. + In addition, platform host rules will only be picked up when `matchHost` is supplied. ### npmjs registry token example @@ -621,7 +621,7 @@ For example, if you set `dockerChildPrefix=myprefix_` then the final container c !!! note - Dangling containers are only removed when Renovate runs again with the same prefix. + Dangling containers are only removed when Renovate runs again with the same prefix. ## `dockerCliOptions` @@ -708,8 +708,8 @@ If you must expose all environment variables to package managers, you can set th !!! warning - Always consider the security implications of using `exposeAllEnv`! - Secrets and other confidential information stored in environment variables could be leaked by a malicious script, that enumerates all environment variables. + Always consider the security implications of using `exposeAllEnv`! + Secrets and other confidential information stored in environment variables could be leaked by a malicious script, that enumerates all environment variables. Set `exposeAllEnv` to `true` only if you have reviewed, and trust, the repositories which Renovate bot runs against. Alternatively, you can use the [`customEnvVariables`](./self-hosted-configuration.md#customenvvariables) config option to handpick a set of variables you need to expose. @@ -758,7 +758,7 @@ Renovate will then create branches on the fork and opens Pull Requests on the pa !!! note - Forked repositories will always be skipped when `forkToken` is set, even if `includeForks` is true. + Forked repositories will always be skipped when `forkToken` is set, even if `includeForks` is true. ## `gitNoVerify` @@ -776,7 +776,7 @@ Replace the newlines with `\n` before adding the resulting single-line value to !!! note - The private key can't be protected with a passphrase if running in a headless environment. Renovate will not be able to handle entering the passphrase. + The private key can't be protected with a passphrase if running in a headless environment. Renovate will not be able to handle entering the passphrase. It will be loaded _lazily_. Before the first commit in a repository, Renovate will: @@ -796,11 +796,11 @@ When provided, Renovate will automatically decrypt the SSH private key during th !!! note - Passphrases are not yet supported for GPG keys. If you provide a passphrase for a GPG key, it will be ignored and a warning will be logged. + Passphrases are not yet supported for GPG keys. If you provide a passphrase for a GPG key, it will be ignored and a warning will be logged. !!! warning - Store this value securely as it provides access to decrypt your private key. Consider using environment variables or secure secret management systems rather than storing it in plain text configuration files. + Store this value securely as it provides access to decrypt your private key. Consider using environment variables or secure secret management systems rather than storing it in plain text configuration files. ## `gitTimeout` @@ -831,9 +831,9 @@ Use the `extends` field instead of this if, for example, you need the ability fo !!! warning - `globalExtends` presets can't be private. - When Renovate resolves `globalExtends` it does not fully process the configuration. - This means that Renovate does not have the authentication it needs to fetch private things. + `globalExtends` presets can't be private. + When Renovate resolves `globalExtends` it does not fully process the configuration. + This means that Renovate does not have the authentication it needs to fetch private things. ## `httpCacheTtlDays` @@ -843,7 +843,7 @@ Value of `0` means no caching. !!! warning - When you set `httpCacheTtlDays` to `0`, Renovate will remove the cached HTTP data. + When you set `httpCacheTtlDays` to `0`, Renovate will remove the cached HTTP data. ## `ignorePrAuthor` @@ -885,8 +885,8 @@ The inherited config may include all valid repository config and these config op !!! note - The above list is prepared manually and may become out of date. - Consult the self-hosted configuration docs and look for `inheritConfigSupport` values there for the definitive list. + The above list is prepared manually and may become out of date. + Consult the self-hosted configuration docs and look for `inheritConfigSupport` values there for the definitive list. This way organizations can change/control the default behavior, like whether configs are required and how repositories are onboarded. @@ -911,7 +911,7 @@ When you set `inheritConfigStrict=true` then Renovate will abort the run and rai !!! warning - Only set this config option to `true` if _every_ organization has an inherited config file _and_ you want to make sure Renovate _always_ uses that inherited config. + Only set this config option to `true` if _every_ organization has an inherited config file _and_ you want to make sure Renovate _always_ uses that inherited config. ## `logContext` @@ -971,7 +971,7 @@ In the above example any reference to the `@company` preset will be replaced wit !!! tip - Combine `migratePresets` with `configMigration` if you'd like your config migrated by PR. + Combine `migratePresets` with `configMigration` if you'd like your config migrated by PR. ## `onboarding` @@ -991,7 +991,7 @@ By default this option is set to `null`. !!! note - This setting is independent of `branchPrefix`. + This setting is independent of `branchPrefix`. For example, if you configure `branchPrefix` to be `renovate-` then you'd still have the onboarding PR created with branch `renovate/configure` until you configure `onboardingBranch=renovate-configure` or similar. If you have an existing Renovate installation and you change `onboardingBranch` then it's possible that you'll get onboarding PRs for repositories that had previously closed the onboarding PR unmerged. @@ -1009,7 +1009,7 @@ Falls back to `renovate.json` if the name provided is not valid. !!! note - If you want renovate to use a custom filename for the onboarding branch you need add allow that filename using the [`configFileNames`](#configfilenames) option. + If you want renovate to use a custom filename for the onboarding branch you need add allow that filename using the [`configFileNames`](#configfilenames) option. ## `onboardingNoDeps` @@ -1081,8 +1081,8 @@ TTL is 15 minutes by default, and it is adjustable in [cacheTtlOverride](#cachet !!! warning - Doing so improves efficiency because shared presets don't need to be reloaded/resolved for every repository, however it also means that private presets can be "leaked" between repositories. - You should only enable this when all repositories are trusted, such as a corporate environment. + Doing so improves efficiency because shared presets don't need to be reloaded/resolved for every repository, however it also means that private presets can be "leaked" between repositories. + You should only enable this when all repositories are trusted, such as a corporate environment. ## `privateKey` @@ -1147,8 +1147,8 @@ sub rsa4096 2021-09-10 [E] !!! note - If you use GnuPG `v2.4` (or newer) to generate the key, then you must disable `AEAD` preferences. - This is needed to allow Renovate to decrypt the encrypted values. + If you use GnuPG `v2.4` (or newer) to generate the key, then you must disable `AEAD` preferences. + This is needed to allow Renovate to decrypt the encrypted values.
key edit log @@ -1184,9 +1184,9 @@ The public key can be used to replace the existing key in !!! note "Base64 Encoding Support" - Renovate supports base64-encoded private keys for easier handling in environment variables or configuration files. - Simply provide the base64-encoded version of your private key, and Renovate will automatically detect and decode it. - This works for both GPG and SSH private keys. + Renovate supports base64-encoded private keys for easier handling in environment variables or configuration files. + Simply provide the base64-encoded version of your private key, and Renovate will automatically detect and decode it. + This works for both GPG and SSH private keys. Any PGP-encrypted secrets must have a mandatory organization/group scope, and optionally can be scoped for a single repository only. The reason for this is to avoid "replay" attacks where someone could learn your encrypted secret and then reuse it in their own Renovate repositories. @@ -1194,9 +1194,9 @@ Instead, with scoped secrets it means that Renovate ensures that the organizatio !!! note - You could use public key encryption with earlier versions of Renovate. - We deprecated this approach and removed the documentation for it. - If you're _still_ using public key encryption then we recommend that you use private keys instead. + You could use public key encryption with earlier versions of Renovate. + We deprecated this approach and removed the documentation for it. + If you're _still_ using public key encryption then we recommend that you use private keys instead. ## `privateKeyOld` @@ -1210,7 +1210,7 @@ You can remove the `privateKeyOld` config option once all the old encrypted valu !!! note - Renovate now logs a warning whenever repositories use non-PGP encrypted config variables. + Renovate now logs a warning whenever repositories use non-PGP encrypted config variables. ## `privateKeyPath` @@ -1328,12 +1328,12 @@ Read more about [the default credential provider chain for AWS SDK for JavaScrip !!! tip - If you're storing the repository cache on Amazon S3 then you may set a folder hierarchy as part of `repositoryCacheType`. - For example, `repositoryCacheType: 's3://bucket-name/dir1/.../dirN/'`. + If you're storing the repository cache on Amazon S3 then you may set a folder hierarchy as part of `repositoryCacheType`. + For example, `repositoryCacheType: 's3://bucket-name/dir1/.../dirN/'`. !!! note - S3 repository is used as a repository cache (e.g. extracted dependencies) and not a lookup cache (e.g. available versions of dependencies). To keep the latter remotely, define [Redis URL](#redisurl). + S3 repository is used as a repository cache (e.g. extracted dependencies) and not a lookup cache (e.g. available versions of dependencies). To keep the latter remotely, define [Redis URL](#redisurl). ## `requireConfig` @@ -1428,7 +1428,7 @@ You can control if Renovate should try to access these services with the `useClo !!! note - This should only be set via an environment variable, as it is used before Renovate initialises its global configuration. + This should only be set via an environment variable, as it is used before Renovate initialises its global configuration. ## `userAgent` diff --git a/docs/usage/self-hosted-experimental.md b/docs/usage/self-hosted-experimental.md index 6bb91b334b..15dddec307 100644 --- a/docs/usage/self-hosted-experimental.md +++ b/docs/usage/self-hosted-experimental.md @@ -107,8 +107,8 @@ Allowed values are `js-java`, `wasm-java` and `wasm-dotnet`. !!! note - `js-java` and `wasm-dotnet` are not recommended due to performance reasons. - Incompatible with `RENOVATE_X_USE_OPENPGP`. + `js-java` and `wasm-dotnet` are not recommended due to performance reasons. + Incompatible with `RENOVATE_X_USE_OPENPGP`. Default: `wasm-java`. @@ -125,7 +125,7 @@ If set, Renovate will rewrite GitHub Enterprise Server's pagination responses to !!! note - For the GitHub Enterprise Server platform only. + For the GitHub Enterprise Server platform only. ## `RENOVATE_X_SQLITE_BUSY_TIMEOUT` @@ -144,11 +144,11 @@ If set to a valid path pointing to a file containing a _valid_ Renovate configur !!! warning - If the file is missing or contains invalid configuration, the scan will be aborted. + If the file is missing or contains invalid configuration, the scan will be aborted. !!! note - You probably **shouldn’t use this** unless you have a very specific reason to override the repository’s normal configuration resolution process. + You probably **shouldn’t use this** unless you have a very specific reason to override the repository’s normal configuration resolution process. ## `RENOVATE_X_SUPPRESS_PRE_COMMIT_WARNING` @@ -158,7 +158,7 @@ Suppress the pre-commit support warning in PR bodies. !!! note - Incompatible with `RENOVATE_X_PGP_RUNTIME`. + Incompatible with `RENOVATE_X_PGP_RUNTIME`. Use `openpgp` instead of [Bouncy Castle](https://www.bouncycastle.org/) for `PGP` decryption. diff --git a/docs/usage/string-pattern-matching.md b/docs/usage/string-pattern-matching.md index 1fbb7a36e3..e3fd3808cb 100644 --- a/docs/usage/string-pattern-matching.md +++ b/docs/usage/string-pattern-matching.md @@ -66,8 +66,8 @@ You can use the Code Generator in the sidebar and copy the regex in the generate !!! warning "Escape the backslashes from regex101" - Before you copy/paste the regex from regex101 into your Renovate config, you must escape the backslashes (`\`) first. - For example: `\n\s` → `\\n\\s`. + Before you copy/paste the regex from regex101 into your Renovate config, you must escape the backslashes (`\`) first. + For example: `\n\s` → `\\n\\s`. ## Glob matching diff --git a/docs/usage/updating-rebasing.md b/docs/usage/updating-rebasing.md index 67d50660ed..473fdcae0f 100644 --- a/docs/usage/updating-rebasing.md +++ b/docs/usage/updating-rebasing.md @@ -28,8 +28,8 @@ It is up to you to either finish the job and merge the PR, or rename it and clos !!! warning - Do _not_ amend Renovate's commits, because Renovate will rebase over your amended commit. - Keep your work safe and always push your own _new_ commit to any Renovate branch. + Do _not_ amend Renovate's commits, because Renovate will rebase over your amended commit. + Keep your work safe and always push your own _new_ commit to any Renovate branch. ## Rebasing conflicted PRs diff --git a/docs/usage/user-stories/maintaining-aur-packages-with-renovate.md b/docs/usage/user-stories/maintaining-aur-packages-with-renovate.md index e0ca464c1b..fe23858bdf 100644 --- a/docs/usage/user-stories/maintaining-aur-packages-with-renovate.md +++ b/docs/usage/user-stories/maintaining-aur-packages-with-renovate.md @@ -15,8 +15,8 @@ title: Maintaining AUR packages with Renovate !!! note - Jamie Magee helps to maintain Renovate. - They obviously like Renovate, and want you to use it. + Jamie Magee helps to maintain Renovate. + They obviously like Renovate, and want you to use it. One big advantage that Arch Linux has over other distributions, apart from being able to say “BTW I use Arch.”, is the Arch User Repository (AUR). It’s a community-driven repository with over 80,000 packages. diff --git a/tools/mkdocs/mkdocs-hooks/markdown-tab-length.py b/tools/mkdocs/mkdocs-hooks/markdown-tab-length.py new file mode 100644 index 0000000000..9b22ef6cab --- /dev/null +++ b/tools/mkdocs/mkdocs-hooks/markdown-tab-length.py @@ -0,0 +1,11 @@ +import markdown + +_orig_init = markdown.Markdown.__init__ + + +def _patched_init(self, **kwargs): + kwargs.setdefault('tab_length', 2) + _orig_init(self, **kwargs) + + +markdown.Markdown.__init__ = _patched_init diff --git a/tools/mkdocs/mkdocs.yml b/tools/mkdocs/mkdocs.yml index 7e5ababe03..8c46752a3b 100644 --- a/tools/mkdocs/mkdocs.yml +++ b/tools/mkdocs/mkdocs.yml @@ -22,6 +22,7 @@ remote_branch: gh-pages hooks: - mkdocs-hooks/custom-edit-url.py + - mkdocs-hooks/markdown-tab-length.py - mkdocs-hooks/sidebar-label.py # General site info