mirror of https://github.com/renovatebot/renovate
docs: use relative links (#26044)
parent
adc3e4aa92
commit
4b7a5e7b62
lib/modules
manager
ansible
bazel
bitbucket-pipelines
buildkite
bundler
circleci
cloudbuild
custom/regex
docker-compose
dockerfile
droneci
fleet
flux
gitlabci
gradle
helm-requirements
helm-values
helmfile
helmv3
jsonnet-bundler
kubernetes
nix
nuget
tekton
terraform
velaci
woodpecker
|
@ -12,8 +12,8 @@ If you see anything wrong on this page, please let us know by creating a [Discus
|
|||
| Dependency Dashboard | Yes | No |
|
||||
| Grouped updates | Yes, use community-provided groups, or create your own | Yes, create [`groups`](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#groups) manually |
|
||||
| Upgrades common monorepo packages at once | Yes | No |
|
||||
| Officially supported platforms | GitHub, GitLab, Bitbucket, Azure, Gitea, see [full list](https://docs.renovatebot.com/#supported-platforms) | GitHub only |
|
||||
| Supported languages | [List for Renovate](https://docs.renovatebot.com/modules/manager/) | [List for Dependabot](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates#supported-repositories-and-ecosystems) |
|
||||
| Officially supported platforms | GitHub, GitLab, Bitbucket, Azure, Gitea, see [full list](./index.md#supported-platforms) | GitHub only |
|
||||
| Supported languages | [List for Renovate](./modules/manager/index.md) | [List for Dependabot](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates#supported-repositories-and-ecosystems) |
|
||||
| Show changelogs | Yes | Yes |
|
||||
| Compatibility score badges | Four badges showing: Age, Adoption, Passing, Confidence | One badge with overall compatibility score |
|
||||
| Built-in to GitHub | No, requires app or self-hosting | Yes |
|
||||
|
@ -46,7 +46,7 @@ Dependabot can group dependencies into a single PR too, but you must set your ow
|
|||
|
||||
### Upgrades common monorepo packages at once
|
||||
|
||||
Renovate has a [`group:monorepos`](https://docs.renovatebot.com/presets-group/#groupmonorepos) preset, that upgrades common monorepo packages in a single PR.
|
||||
Renovate has a [`group:monorepos`](./presets-group.md#groupmonorepos) preset, that upgrades common monorepo packages in a single PR.
|
||||
|
||||
Dependabot does not update common monorepo packages in a single PR.
|
||||
|
||||
|
@ -55,14 +55,14 @@ Dependabot does not update common monorepo packages in a single PR.
|
|||
Platform means the Git-hosting site or program, for example GitHub, GitLab or Azure.
|
||||
|
||||
Renovate works on multiple platforms, including GitHub.
|
||||
Read the [list of Renovate platforms](https://docs.renovatebot.com/modules/platform/) to learn more.
|
||||
Read the [list of Renovate platforms](./modules/platform/index.md) to learn more.
|
||||
|
||||
The _official_ Dependabot program only works on GitHub.
|
||||
If you're an advanced user, you may use the [`dependabot-core` repository](https://github.com/dependabot/dependabot-core) as a base to build your own Dependabot, which you can run on other platforms.
|
||||
|
||||
### Supported languages
|
||||
|
||||
- [Renovate's supported managers](https://docs.renovatebot.com/modules/manager/)
|
||||
- [Renovate's supported managers](./modules/manager/index.md)
|
||||
- [Dependabot's supported repositories and ecosystems](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates#supported-repositories-and-ecosystems)
|
||||
|
||||
### Show changelogs
|
||||
|
@ -130,7 +130,7 @@ This section explains how to self-host each bot.
|
|||
|
||||
### Self-hosting Renovate
|
||||
|
||||
You can self-host Renovate on all [officially supported platforms](https://docs.renovatebot.com/#supported-platforms).
|
||||
You can self-host Renovate on all [officially supported platforms](./index.md#supported-platforms).
|
||||
|
||||
If you decide to self-host Renovate, read the items from the [Self-hosting Renovate reading list](./reading-list.md#self-hosting-renovate).
|
||||
|
||||
|
|
|
@ -114,7 +114,7 @@ It mostly uses Renovate config defaults but adds a few smart customizations such
|
|||
By default, Renovate App's onboarding PR suggests the `["config:recommended]"` preset.
|
||||
If you're self hosting, and want to use the `config:recommended` preset, then you must add `"onboardingConfig": { "extends": ["config:recommended"] }` to your bot's config.
|
||||
|
||||
Read the [Full Config Presets](https://docs.renovatebot.com/presets-config/) page to learn more about our `config:` presets.
|
||||
Read the [Full Config Presets](./presets-config.md) page to learn more about our `config:` presets.
|
||||
|
||||
A typical onboarding `renovate.json` looks like this:
|
||||
|
||||
|
|
|
@ -443,7 +443,7 @@ For example, To add `[skip ci]` to every commit you could configure:
|
|||
|
||||
Another example would be if you want to configure a DCO signoff to each commit.
|
||||
|
||||
If you want Renovate to signoff its commits, add the [`:gitSignOff` preset](https://docs.renovatebot.com/presets-default/#gitsignoff) to your `extends` array:
|
||||
If you want Renovate to signoff its commits, add the [`:gitSignOff` preset](./presets-default.md#gitsignoff) to your `extends` array:
|
||||
|
||||
```json
|
||||
{
|
||||
|
@ -689,7 +689,7 @@ For template fields, use the triple brace `{{{ }}}` notation to avoid Handlebars
|
|||
|
||||
<!-- prettier-ignore -->
|
||||
!!! tip
|
||||
Look at our [Regex Manager Presets](https://docs.renovatebot.com/presets-regexManagers/), they may have what you need.
|
||||
Look at our [Regex Manager Presets](./presets-regexManagers.md), they may have what you need.
|
||||
|
||||
### customType
|
||||
|
||||
|
@ -1883,7 +1883,7 @@ Specifies the private key in [PEM format](https://en.wikipedia.org/wiki/Privacy-
|
|||
<!-- prettier-ignore -->
|
||||
!!! warning
|
||||
Do _not_ put your private key into this field, to avoid losing confidentiality completely.
|
||||
You must use [secrets](https://docs.renovatebot.com/self-hosted-configuration/#secrets) to pass it down securely instead.
|
||||
You must use [secrets](./self-hosted-configuration.md#secrets) to pass it down securely instead.
|
||||
|
||||
### httpsCertificate
|
||||
|
||||
|
@ -2188,15 +2188,15 @@ Set `osvVulnerabilityAlerts` to `true` to get pull requests with vulnerability f
|
|||
You will only get OSV-based vulnerability alerts for _direct_ dependencies.
|
||||
Renovate only queries the OSV database for dependencies that use one of these datasources:
|
||||
|
||||
- [`crate`](https://docs.renovatebot.com/modules/datasource/crate/)
|
||||
- [`go`](https://docs.renovatebot.com/modules/datasource/go/)
|
||||
- [`hex`](https://docs.renovatebot.com/modules/datasource/hex/)
|
||||
- [`maven`](https://docs.renovatebot.com/modules/datasource/maven/)
|
||||
- [`npm`](https://docs.renovatebot.com/modules/datasource/npm/)
|
||||
- [`nuget`](https://docs.renovatebot.com/modules/datasource/nuget/)
|
||||
- [`packagist`](https://docs.renovatebot.com/modules/datasource/packagist/)
|
||||
- [`pypi`](https://docs.renovatebot.com/modules/datasource/pypi/)
|
||||
- [`rubygems`](https://docs.renovatebot.com/modules/datasource/rubygems/)
|
||||
- [`crate`](./modules/datasource/crate/index.md)
|
||||
- [`go`](./modules/datasource/go/index.md)
|
||||
- [`hex`](./modules/datasource/hex/index.md)
|
||||
- [`maven`](./modules/datasource/maven/index.md)
|
||||
- [`npm`](./modules/datasource/npm/index.md)
|
||||
- [`nuget`](./modules/datasource/nuget/index.md)
|
||||
- [`packagist`](./modules/datasource/packagist/index.md)
|
||||
- [`pypi`](./modules/datasource/pypi/index.md)
|
||||
- [`rubygems`](./modules/datasource/rubygems/index.md)
|
||||
|
||||
## packageRules
|
||||
|
||||
|
@ -3453,7 +3453,7 @@ The default value for `schedule` is "at any time", which is functionally the sam
|
|||
i.e. Renovate will run on the repository around the clock.
|
||||
|
||||
The easiest way to define a schedule is to use a preset if one of them fits your requirements.
|
||||
See [Schedule presets](https://docs.renovatebot.com/presets-schedule/) for details and feel free to request a new one in the source repository if you think it would help others.
|
||||
See [Schedule presets](./presets-schedule.md) for details and feel free to request a new one in the source repository if you think it would help others.
|
||||
|
||||
```title="Some text schedules that are known to work"
|
||||
every weekend
|
||||
|
|
|
@ -60,7 +60,7 @@ Once you have enabled Renovate on a repository, you will get a "Configure Renova
|
|||
### No risk onboarding
|
||||
|
||||
Conveniently, Renovate will not make any changes to your repository or raise any further Pull Requests until after you _merge_ the onboarding Pull Request.
|
||||
If there is anything about the Pull Request that you don't like or understand, take your time to read the [documentation](https://docs.renovatebot.com) or ask questions on the [discussions forum on GitHub](https://github.com/renovatebot/renovate/discussions) and merge the PR only once you're satisfied with the result.
|
||||
If there is anything about the Pull Request that you don't like or understand, take your time to read the [documentation](../index.md) or ask questions on the [discussions forum on GitHub](https://github.com/renovatebot/renovate/discussions) and merge the PR only once you're satisfied with the result.
|
||||
|
||||
You can edit your Renovate configuration **within the `renovate/configure` branch** and Renovate will keep updating the description in the PR to match, so you can work on the config until you're satisfied with the results.
|
||||
|
||||
|
|
|
@ -202,12 +202,12 @@ We also recommend you configure `config.gitAuthor` with the same identity as you
|
|||
|
||||
Read the platform-specific docs to learn how to setup authentication on your platform:
|
||||
|
||||
- [Azure DevOps](https://docs.renovatebot.com/modules/platform/azure/)
|
||||
- [Bitbucket Cloud](https://docs.renovatebot.com/modules/platform/bitbucket/)
|
||||
- [Bitbucket Server](https://docs.renovatebot.com/modules/platform/bitbucket-server/)
|
||||
- [Gitea and Forgejo](https://docs.renovatebot.com/modules/platform/gitea/)
|
||||
- [github.com and GitHub Enterprise Server](https://docs.renovatebot.com/modules/platform/github/)
|
||||
- [GitLab](https://docs.renovatebot.com/modules/platform/gitlab/)
|
||||
- [Azure DevOps](../modules/platform/azure/index.md)
|
||||
- [Bitbucket Cloud](../modules/platform/bitbucket/index.md)
|
||||
- [Bitbucket Server](../modules/platform/bitbucket-server/index.md)
|
||||
- [Gitea and Forgejo](../modules/platform/gitea/index.md)
|
||||
- [github.com and GitHub Enterprise Server](../modules/platform/github/index.md)
|
||||
- [GitLab](../modules/platform/gitlab/index.md)
|
||||
|
||||
### GitHub.com token for changelogs
|
||||
|
||||
|
|
|
@ -127,7 +127,7 @@ To learn more about "automerge" read the [key concepts, automerge](../key-concep
|
|||
|
||||
We use these Renovate features to automerge an internal dependency:
|
||||
|
||||
- [Git submodule support](https://docs.renovatebot.com/modules/manager/git-submodules/)
|
||||
- [Git submodule support](../modules/manager/git-submodules/index.md)
|
||||
- [`automerge`](../configuration-options.md#automerge) set to `true`
|
||||
- [`automergeType`](../configuration-options.md#automergetype) set to `branch`
|
||||
|
||||
|
|
|
@ -45,7 +45,7 @@ This is similar to the way you can share ESLint configurations.
|
|||
## Built-in presets
|
||||
|
||||
Renovate comes with a lot of built-in presets that you can use.
|
||||
Browse [Renovate's default presets](https://docs.renovatebot.com/presets-default/) to find any that are useful to you.
|
||||
Browse [Renovate's default presets](../presets-default.md) to find any that are useful to you.
|
||||
Once you find a preset you like, put it in an `extends` array in your config file.
|
||||
|
||||
### Contributing a new built-in preset
|
||||
|
@ -58,5 +58,5 @@ Read [Contributing to presets](../config-presets.md#contributing-to-presets) to
|
|||
|
||||
In short:
|
||||
|
||||
- Browse [Renovate's default presets](https://docs.renovatebot.com/presets-default/) to find any that are useful to you
|
||||
- Browse [Renovate's default presets](../presets-default.md) to find any that are useful to you
|
||||
- Publish your own if you wish to reuse them across repositories
|
||||
|
|
|
@ -109,7 +109,7 @@ Some config examples:
|
|||
|
||||
#### Schedule presets
|
||||
|
||||
Renovate has preset schedules that you might want to use, go to [Schedule Presets](https://docs.renovatebot.com/presets-schedule/) to see them.
|
||||
Renovate has preset schedules that you might want to use, go to [Schedule Presets](../presets-schedule.md) to see them.
|
||||
|
||||
These preset schedules only affect when Renovate bot checks for updates, and do not affect any specific dependencies/packages.
|
||||
|
||||
|
|
|
@ -6,7 +6,7 @@ description: Python/pip dependencies support in Renovate
|
|||
# Python package manager support
|
||||
|
||||
Renovate supports several Python package managers, including `pip`, `pipenv`, `poetry`, etc.
|
||||
See [all supported managers](https://docs.renovatebot.com/modules/manager/).
|
||||
See [all supported managers](./modules/manager/index.md).
|
||||
|
||||
## Versioning support
|
||||
|
||||
|
|
|
@ -41,7 +41,7 @@ If you're using `config:recommended` now, replace it with `config:best-practices
|
|||
|
||||
### What's in the `config:best-practices` preset?
|
||||
|
||||
The [`config:best-practices` preset](https://docs.renovatebot.com/presets-config/#configbest-practices) has this configuration:
|
||||
The [`config:best-practices` preset](./presets-config.md#configbest-practices) has this configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
|
@ -125,7 +125,7 @@ When you're behind on updates, you'll have a bad time, because you must read _mo
|
|||
|
||||
Finally, when you're updating often, you'll start looking for ways to automate the updates.
|
||||
You may start to [`automerge`](./configuration-options.md#automerge) development dependencies like Prettier, or ESLint when the linter passes.
|
||||
Or you may decide to automerge any `patch` type upgrades, by using the [`default:automergePatch`](https://docs.renovatebot.com/presets-default/#automergepatch) preset.
|
||||
Or you may decide to automerge any `patch` type upgrades, by using the [`default:automergePatch`](./presets-default.md#automergepatch) preset.
|
||||
|
||||
You may also start using [GitHub's pull request merge queues](./key-concepts/automerge.md#github-merge-queue) to speed up the merge process.
|
||||
Renovate does not support GitLab's Merge Trains, see [issue #5573](https://github.com/renovatebot/renovate/issues/5573).
|
||||
|
@ -195,7 +195,7 @@ Say you're on version `1` of a dependency, and the latest `major` version is at
|
|||
You should update to `2`, then `3` and finally `4`.
|
||||
Avoid updating from `1` directly to `4`.
|
||||
|
||||
Use the [`:separateMultipleMajorReleases`](https://docs.renovatebot.com/presets-default/#separatemultiplemajorreleases) preset to get separate `major` updates.
|
||||
Use the [`:separateMultipleMajorReleases`](./presets-default.md#separatemultiplemajorreleases) preset to get separate `major` updates.
|
||||
|
||||
### Update development tools
|
||||
|
||||
|
|
|
@ -35,9 +35,9 @@ You might have seen it opening pull requests on GitHub and making updates for np
|
|||
|
||||
Renovate has a couple of concepts that I need to explain first: [datasources](../modules/datasource/index.md) and [managers](../modules/manager/index.md).
|
||||
Datasources define where to look for new versions of a dependency.
|
||||
Renovate comes with over 50 different datasources, but the one that is important for AUR packages is the [`git-tags` datasource](https://docs.renovatebot.com/modules/datasource/#git-tags-datasource).
|
||||
Renovate comes with over 50 different datasources, but the one that is important for AUR packages is the [`git-tags` datasource](../modules/datasource/git-tags/index.md).
|
||||
Managers are the Renovate concept for package managers.
|
||||
There isn’t an AUR or `PKGBUILD` manager, but there is a [regex manager](https://docs.renovatebot.com/modules/manager/regex/) that I can use.
|
||||
There isn’t an AUR or `PKGBUILD` manager, but there is a [regex manager](../modules/manager/regex/index.md) that I can use.
|
||||
|
||||
I can create a `renovate.json` configuration with the following custom manager configuration:
|
||||
|
||||
|
@ -68,7 +68,7 @@ And here’s an extract from the PKGBUILD for the [bicep-bin](https://aur.archli
|
|||
pkgver=0.15.31 # renovate: datasource=github-tags depName=Azure/bicep
|
||||
```
|
||||
|
||||
Here I’m configuring Renovate to use the [`github-tags`](https://docs.renovatebot.com/modules/datasource/github-tags/) datasource and to look in the [`Azure/bicep` GitHub repository](https://github.com/Azure/bicep) for new versions.
|
||||
Here I’m configuring Renovate to use the [`github-tags`](../modules/datasource/github-tags/index.md) datasource and to look in the [`Azure/bicep` GitHub repository](https://github.com/Azure/bicep) for new versions.
|
||||
That means it’ll look in the [list of tags for the `Azure/bicep` repository](https://github.com/Azure/bicep/tags) for any new versions.
|
||||
If Renovate finds any new versions, it’ll automatically update the `PKGBUILD` and open a pull request with the updated version.
|
||||
|
||||
|
|
|
@ -176,7 +176,7 @@ Some features and options we enjoy:
|
|||
- [Integration with GitHub’s Dependabot alerts](../configuration-options.md#vulnerabilityalerts) to raise the priority and send security remediation PRs as soon as possible
|
||||
- Each rule can be customized either globally [or specified per package](../configuration-options.md#packagerules)
|
||||
- Works with your [private package registry](../getting-started/private-packages.md)
|
||||
- Supports more than 70 [languages and package managers](https://docs.renovatebot.com/modules/manager/#supported-managers): Maven, Docker, npm, Docker Compose, Python
|
||||
- Supports more than 70 [languages and package managers](../modules/manager/index.md#supported-managers): Maven, Docker, npm, Docker Compose, Python
|
||||
- If you are using dependencies in a custom way, [there is a `customManagers` option](../configuration-options.md#custommanagers) that allows you to transform patterns into dependencies
|
||||
|
||||
There is an [on-premise option](https://www.mend.io/free-developer-tools/renovate/on-premises/), but you can also use [the Mend Renovate App](https://github.com/marketplace/renovate).
|
||||
|
|
|
@ -185,7 +185,7 @@ The following JSON will be generated:
|
|||
|
||||
After the conversion, any `jsonata` rules defined in the `transformTemplates` section will be applied to process the JSON data.
|
||||
|
||||
To extract the version number, you may use [`extractVersion`](../../../../docs/usage/configuration-options.md#extractversion) or JSONata rules.
|
||||
To extract the version number, you may use [`extractVersion`](../../../configuration-options.md#extractversion) or JSONata rules.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
You can use this datasource plus [regex managers](https://docs.renovatebot.com/modules/manager/regex/) to update git-based dependencies that are not natively supported by Renovate.
|
||||
You can use this datasource plus [regex managers](../../manager/regex/index.md) to update git-based dependencies that are not natively supported by Renovate.
|
||||
|
||||
The `git-refs` datasource returns a reference from a Git repository.
|
||||
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
[GitLab Packages API](https://docs.gitlab.com/ee/api/packages.html) supports looking up package versions from [all types of packages registry supported by GitLab](https://docs.gitlab.com/ee/user/packages/package_registry/index.html) and can be used in combination with [regex managers](https://docs.renovatebot.com/modules/manager/regex/) to keep dependencies up-to-date which are not specifically supported by Renovate.
|
||||
[GitLab Packages API](https://docs.gitlab.com/ee/api/packages.html) supports looking up package versions from [all types of packages registry supported by GitLab](https://docs.gitlab.com/ee/user/packages/package_registry/index.html) and can be used in combination with [regex managers](../../manager/regex/index.md) to keep dependencies up-to-date which are not specifically supported by Renovate.
|
||||
|
||||
To specify which specific repository should be queried when looking up a package, the `packageName` should be formed with the project path first, then a `:` and finally the package name.
|
||||
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
[GitLab Releases API](https://docs.gitlab.com/ee/api/releases/) supports looking up [releases supported by GitLab](https://docs.gitlab.com/ee/user/project/releases/) and can be used in combination with [regex managers](https://docs.renovatebot.com/modules/manager/regex/) to keep dependencies up-to-date which are not specifically supported by Renovate.
|
||||
[GitLab Releases API](https://docs.gitlab.com/ee/api/releases/) supports looking up [releases supported by GitLab](https://docs.gitlab.com/ee/user/project/releases/) and can be used in combination with [regex managers](../../manager/regex/index.md) to keep dependencies up-to-date which are not specifically supported by Renovate.
|
||||
|
||||
To specify which specific repository should be queried when looking up a package, the `packageName` should be set to the project path.
|
||||
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
[GitLab Tags API](https://docs.gitlab.com/ee/api/tags.html) supports looking up [Git tags](https://docs.gitlab.com/ee/topics/git/tags.html#tags) and can be used in combination with [regex managers](https://docs.renovatebot.com/modules/manager/regex/) to keep dependencies up-to-date which are not specifically supported by Renovate.
|
||||
[GitLab Tags API](https://docs.gitlab.com/ee/api/tags.html) supports looking up [Git tags](https://docs.gitlab.com/ee/topics/git/tags.html#tags) and can be used in combination with [regex managers](../../manager/regex/index.md) to keep dependencies up-to-date which are not specifically supported by Renovate.
|
||||
|
||||
To specify which specific repository should be queried when looking up a package, the `packageName` should be set to the project path.
|
||||
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
With [Repology](https://repology.org/) you can look up package versions from many package repositories.
|
||||
You can combine Repology with [regex managers](https://docs.renovatebot.com/modules/manager/regex/) to update dependencies which are not supported by Renovate.
|
||||
You can combine Repology with [regex managers](../../manager/regex/index.md) to update dependencies which are not supported by Renovate.
|
||||
|
||||
The `packageName` field should be constructed using the repository identifier and the actual package name separated by a slash.
|
||||
For example: `alpine_3_12/gcc` would look for a binary (or source package) called `gcc` within the `alpine_3_12` repository.
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
Supports Docker-type dependency extraction from Ansible configuration files.
|
||||
|
||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read the [versioning](../../versioning.md) documentation to learn more.
|
||||
|
|
|
@ -2,4 +2,4 @@ Bazel is quite unlike most other "package managers" that Renovate supports, whic
|
|||
Instead, Bazel is a build tool so supports a multitude of languages/datasources.
|
||||
Renovate does not support all possible Bazel references, although would like to, and feature requests are welcome.
|
||||
|
||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read the [versioning](../../versioning.md) documentation to learn more.
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
Extracts dependencies from Bitbucket Pipelines config files.
|
||||
|
||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read the [versioning](../../versioning.md) documentation to learn more.
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
Used for updating Docker dependencies in Buildkite configuration files.
|
||||
|
||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read the [versioning](../../versioning.md) documentation to learn more.
|
||||
|
|
|
@ -29,4 +29,4 @@ Instead of `token`, you may also supply `username` and `password` instead.
|
|||
If you don't want to commit raw secrets to your repository, either:
|
||||
|
||||
- If self hosting, add the `hostRules` to your bot's configuration file rather than the repository's configuration file, or
|
||||
- If using the Mend Renovate App, make use of the [`encrypted`](https://docs.renovatebot.com/configuration-options/#encrypted) capability
|
||||
- If using the Mend Renovate App, make use of the [`encrypted`](../../../configuration-options.md#encrypted) capability
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
The `circleci` manager extracts both `docker` as well as `orb` datasources from CircleCI config files.
|
||||
|
||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read the [versioning](../../versioning.md) documentation to learn more.
|
||||
|
||||
### Private orbs
|
||||
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
The `cloudbuild` manager extracts `docker` datasources from [Cloud Build config files](https://cloud.google.com/build/docs/configuring-builds/create-basic-configuration).
|
||||
|
||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read the [versioning](../../versioning.md) documentation to learn more.
|
||||
|
|
|
@ -6,8 +6,8 @@ The `regex` manager is unique in Renovate because:
|
|||
- It can extract any `datasource`
|
||||
- By using the `customManagers` config, you can create multiple "regex managers" for the same repository
|
||||
|
||||
We have [additional Handlebars helpers](https://docs.renovatebot.com/templates/#additional-handlebars-helpers) to help you perform common transformations on the regex manager's template fields.
|
||||
Also read the documentation for the [`customManagers` config option](https://docs.renovatebot.com/configuration-options/#custommanagers).
|
||||
We have [additional Handlebars helpers](../../../templates.md#additional-handlebars-helpers) to help you perform common transformations on the regex manager's template fields.
|
||||
Also read the documentation for the [`customManagers` config option](../../../configuration-options.md#custommanagers).
|
||||
|
||||
### Required Fields
|
||||
|
||||
|
@ -19,8 +19,8 @@ The first two required fields are `fileMatch` and `matchStrings`:
|
|||
Before Renovate can look up a dependency and decide about updates, it needs this information about each dependency:
|
||||
|
||||
- The dependency's name
|
||||
- Which `datasource` to use: npm, Docker, GitHub tags, and so on. For how to format this references see [datasource overview](https://docs.renovatebot.com/modules/datasource/#supported-datasources)
|
||||
- Which version scheme to use: defaults to `semver-coerced`, but you may set another value like `pep440`. Supported versioning schemes can be found in the [versioning overview](https://docs.renovatebot.com/modules/versioning/#supported-versioning)
|
||||
- Which `datasource` to use: npm, Docker, GitHub tags, and so on. For how to format this references see [datasource overview](../../datasource/index.md#supported-datasources)
|
||||
- Which version scheme to use: defaults to `semver-coerced`, but you may set another value like `pep440`. Supported versioning schemes can be found in the [versioning overview](../../versioning.md#supported-versioning)
|
||||
|
||||
Configuration-wise, it works like this:
|
||||
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
Extracts all Docker images from with Docker Compose YAML files.
|
||||
|
||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read the [versioning](../../versioning.md) documentation to learn more.
|
||||
|
|
|
@ -19,4 +19,4 @@ For example, if you know that an image follows SemVer, you can tell Renovate to
|
|||
}
|
||||
```
|
||||
|
||||
Read [Renovate's Docker Versioning](https://docs.renovatebot.com/modules/versioning/#docker-versioning) docs to learn more.
|
||||
Read [Renovate's Docker Versioning](../../versioning.md#docker-versioning) docs to learn more.
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
Extracts Docker-type dependencies from DroneCI config files.
|
||||
|
||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read the [versioning](../../versioning.md) documentation to learn more.
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
Can upgrade bundle definitions and GitRepo YAML manifests of Rancher Fleet.
|
||||
|
||||
By default, only bundles with Helm references will be upgraded.
|
||||
To enable GitRepo updates you have to extend your [`fileMatch`](https://docs.renovatebot.com/configuration-options/#filematch) configuration.
|
||||
To enable GitRepo updates you have to extend your [`fileMatch`](../../../configuration-options.md#filematch) configuration.
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
|
@ -80,4 +80,4 @@ If instead you have all your Flux manifests inside a `flux/` directory, you woul
|
|||
|
||||
### Versioning
|
||||
|
||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read the [versioning](../../versioning.md) documentation to learn more.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
Extracts Docker dependencies from `gitlab-ci.yml` files.
|
||||
|
||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read the [versioning](../../versioning.md) documentation to learn more.
|
||||
|
||||
If you use Gitlab Dependency Proxy then you can use these predefined variables as prefixes for your image:
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ It does not call `gradle` directly in order to extract a list of dependencies.
|
|||
### Updating lockfiles
|
||||
|
||||
The gradle manager supports gradle lock files in `.lockfile` artifacts, as well as lock files used by the [gradle-consistent-versions](https://github.com/palantir/gradle-consistent-versions) plugin.
|
||||
During [lock file maintenance](https://docs.renovatebot.com/configuration-options/#lockfilemaintenance), renovate calls `./gradlew :dependencies --write-locks` on the root project and subprojects.
|
||||
During [lock file maintenance](../../../configuration-options.md#lockfilemaintenance), renovate calls `./gradlew :dependencies --write-locks` on the root project and subprojects.
|
||||
For regular dependency updates, renovate automatically updates lock state entries via the `--update-locks` command line flag.
|
||||
|
||||
As the output of these commands can be very large, any text other than errors (in `stderr`) is discarded.
|
||||
|
|
|
@ -12,6 +12,6 @@ The `helm-requirements` manager defines this default registryAlias:
|
|||
|
||||
If your Helm charts make use of repository aliases then you will need to configure an `registryAliases` object in your config to tell Renovate where to look for them. Be aware that alias values must be properly formatted URIs.
|
||||
|
||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read the [versioning](../../versioning.md) documentation to learn more.
|
||||
|
||||
To learn how to use Helm with private packages, read [private package support, Package Manager Credentials for Artifact Updating, helm](https://docs.renovatebot.com/getting-started/private-packages/#helm).
|
||||
To learn how to use Helm with private packages, read [private package support, Package Manager Credentials for Artifact Updating, helm](../../../getting-started/private-packages.md#helm).
|
||||
|
|
|
@ -17,4 +17,4 @@ coreImage:
|
|||
tag: 2.1.3-debian-10-r38
|
||||
```
|
||||
|
||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read the [versioning](../../versioning.md) documentation to learn more.
|
||||
|
|
|
@ -12,7 +12,7 @@ The `helmfile` manager defines this default registryAlias:
|
|||
|
||||
If your Helm charts make use of repository aliases then you will need to configure an `registryAliases` object in your config to tell Renovate where to look for them. Be aware that alias values must be properly formatted URIs.
|
||||
|
||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read the [versioning](../../versioning.md) documentation to learn more.
|
||||
|
||||
### Private repositories and registries
|
||||
|
||||
|
|
|
@ -16,7 +16,7 @@ The `helmv3` manager defines this default registryAlias:
|
|||
If you use repository aliases in your Helm charts then you must set an `registryAliases` object in your configuration file so Renovate knows where to find the repository.
|
||||
Alias values must be properly formatted URIs.
|
||||
|
||||
If you need to change the versioning format, read our [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read our [versioning](../../versioning.md) documentation to learn more.
|
||||
|
||||
### Private repositories and registries
|
||||
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
Extracts dependencies from `jsonnetfile.json` files, updates `jsonnetfile.lock.json` and updates the `vendor` directory.
|
||||
|
||||
Supports [lock file maintenance](https://docs.renovatebot.com/configuration-options/#lockfilemaintenance).
|
||||
Supports [lock file maintenance](../../../configuration-options.md#lockfilemaintenance).
|
||||
|
||||
This plugin requires `jsonnet-bundler >= v0.4.0` since previous versions don't support updating single dependencies.
|
||||
|
|
|
@ -31,4 +31,4 @@ Or if it's only a single file then something like this:
|
|||
}
|
||||
```
|
||||
|
||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read the [versioning](../../versioning.md) documentation to learn more.
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
The [`nix`](https://github.com/NixOS/nix) manager supports:
|
||||
|
||||
- [`lockFileMaintenance`](https://docs.renovatebot.com/configuration-options/#lockfilemaintenance) updates for `flake.lock`
|
||||
- [`lockFileMaintenance`](../../../configuration-options.md#lockfilemaintenance) updates for `flake.lock`
|
||||
- [nixpkgs](https://github.com/NixOS/nixpkgs) updates
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
Use [`packageRules`](https://docs.renovatebot.com/configuration-options/#packagerules) to control the behavior of the NuGet package manager.
|
||||
Use [`packageRules`](../../../configuration-options.md#packagerules) to control the behavior of the NuGet package manager.
|
||||
|
||||
The NuGet package manager supports these SDK-style files and formats:
|
||||
|
||||
|
|
|
@ -58,4 +58,4 @@ As an example, the following config matches all the YAML files in a repository:
|
|||
}
|
||||
```
|
||||
|
||||
See our [versioning](https://docs.renovatebot.com/modules/versioning/) documentation for details on the existing versioning rules and possible alterations.
|
||||
See our [versioning](../../versioning.md) documentation for details on the existing versioning rules and possible alterations.
|
||||
|
|
|
@ -102,4 +102,4 @@ You can use these `depTypes` for fine-grained control, for example to disable pa
|
|||
| Kubernetes StatefulSet | `kubernetes_stateful_set` | |
|
||||
| Kubernetes StatefulSet v1 | `kubernetes_stateful_set_v1` | |
|
||||
|
||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read the [versioning](../../versioning.md) documentation to learn more.
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
Extracts Docker-type dependencies from VelaCI config files.
|
||||
|
||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read the [versioning](../../versioning.md) documentation to learn more.
|
||||
|
|
|
@ -4,4 +4,4 @@ Extracts all Docker images from Woodpecker Pipeline YAML files.
|
|||
- [Woodpecker Docs: Pipeline Syntax](https://woodpecker-ci.org/docs/usage/pipeline-syntax) ([section with dependencies](https://woodpecker-ci.org/docs/usage/pipeline-syntax#image))
|
||||
- [`woodpecker-ci` JSON schema](https://raw.githubusercontent.com/woodpecker-ci/woodpecker/master/pipeline/schema/schema.json)
|
||||
|
||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
||||
If you need to change the versioning format, read the [versioning](../../versioning.md) documentation to learn more.
|
||||
|
|
|
@ -103,7 +103,7 @@ The policy json.
|
|||
Set up a global configuration file (`config.js`), or use CLI parameters or environment variables, to run Renovate on CodeCommit:
|
||||
|
||||
- Set `platform: 'codecommit'`
|
||||
- Set `repositories: ['{repository, names, separated, by, comma}']`, or use [Renovate’s `autodiscover` feature](https://docs.renovatebot.com/self-hosted-configuration/#autodiscover)
|
||||
- Set `repositories: ['{repository, names, separated, by, comma}']`, or use [Renovate’s `autodiscover` feature](../../../self-hosted-configuration.md#autodiscover)
|
||||
|
||||
Run Renovate and it will process your repositories.
|
||||
|
||||
|
@ -113,12 +113,12 @@ These features are not supported:
|
|||
|
||||
- Adding assignees to PRs
|
||||
- Auto-merge
|
||||
- [`rebaseLabel`](https://docs.renovatebot.com/configuration-options/#rebaselabel) (request a rebase for Renovate)
|
||||
- [`rebaseLabel`](../../../configuration-options.md#rebaselabel) (request a rebase for Renovate)
|
||||
|
||||
## Recommendations
|
||||
|
||||
- We recommend that you limit the number of open Renovate PRs by setting a `prConcurrentLimit`
|
||||
- Due to current platform limitations, if you close a PR but don’t want for Renovate to recreate the PR, use [package rules](https://docs.renovatebot.com/configuration-options/#packagerules) with the `"enabled": false` key
|
||||
- Due to current platform limitations, if you close a PR but don’t want for Renovate to recreate the PR, use [package rules](../../../configuration-options.md#packagerules) with the `"enabled": false` key
|
||||
|
||||
## Example configuration
|
||||
|
||||
|
|
|
@ -41,5 +41,5 @@ If you use Gitea packages, add the `read:packages` scope.
|
|||
## Repo autodiscover sorting
|
||||
|
||||
You can change the default server-side sort method and order for autodiscover API.
|
||||
Set those via [`RENOVATE_X_AUTODISCOVER_REPO_SORT`](https://docs.renovatebot.com/self-hosted-experimental/#renovate_x_autodiscover_repo_sort) and [`RENOVATE_X_AUTODISCOVER_REPO_ORDER`](https://docs.renovatebot.com/self-hosted-experimental/#renovate_x_autodiscover_repo_order).
|
||||
Set those via [`RENOVATE_X_AUTODISCOVER_REPO_SORT`](../../../self-hosted-experimental.md#renovate_x_autodiscover_repo_sort) and [`RENOVATE_X_AUTODISCOVER_REPO_ORDER`](../../../self-hosted-experimental.md#renovate_x_autodiscover_repo_order).
|
||||
Read the [Gitea swagger docs](https://try.gitea.io/api/swagger#/repository/repoSearch) for more details.
|
||||
|
|
|
@ -40,7 +40,7 @@ If you're using a private [GitLab container registry](https://docs.gitlab.com/ee
|
|||
## Server version dependent features
|
||||
|
||||
We use the GitLab [version API](https://docs.gitlab.com/ee/api/version.html) to fetch the server version.
|
||||
You can use the experimental feature flag [`RENOVATE_X_PLATFORM_VERSION`](https://docs.renovatebot.com/self-hosted-experimental/#renovate_x_platform_version) to set a specific server version.
|
||||
You can use the experimental feature flag [`RENOVATE_X_PLATFORM_VERSION`](../../../self-hosted-experimental.md#renovate_x_platform_version) to set a specific server version.
|
||||
By setting the server version yourself, you save a API call that fetches the server version.
|
||||
|
||||
- Use `Draft:` MR prefix instead of `WIP:` prefix since `v13.2.0`
|
||||
|
|
Loading…
Reference in New Issue