From ed4fc35a0a0446587144d062dee64ad31f7f3914 Mon Sep 17 00:00:00 2001 From: Oleg Krivtsov <olegkrivtsov@gmail.com> Date: Wed, 12 Jan 2022 17:00:25 +0700 Subject: [PATCH] docs(config): document precedence order of config files (#13447) --- docs/usage/configuration-options.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index 1c09574c85..e4490753b1 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -10,15 +10,19 @@ Any config you define applies to the whole repository (e.g. if you have a monore You can store your Renovate configuration file in one of the following locations: -- `.github/renovate.json` -- `.github/renovate.json5` -- `.gitlab/renovate.json` -- `.gitlab/renovate.json5` -- `.renovaterc.json` -- `renovate.json` -- `renovate.json5` -- `.renovaterc` -- `package.json` _(within a `"renovate"` section)_ +1. `renovate.json` +1. `renovate.json5` +1. `.github/renovate.json` +1. `.github/renovate.json5` +1. `.gitlab/renovate.json` +1. `.gitlab/renovate.json5` +1. `.renovaterc` +1. `.renovaterc.json` +1. `package.json` _(within a `"renovate"` section)_ + +_Note_: Storing the Renovate configuration in a `package.json` file is deprecated and support may be removed in the future. + +When renovating a repository, Renovate will try to detect the configuration files in the order listed above, and stop after the first one is found. Renovate always uses the config from the repository's default branch, even if that configuration specifies multiple `baseBranches`. Renovate does not read/override the config from within each base branch if present. -- GitLab