From ff2a15d8688a7cb82219af79cd8e3f3f5e32784c Mon Sep 17 00:00:00 2001 From: Rhys Arkins <rhys@arkins.net> Date: Thu, 15 Dec 2022 19:20:09 +0100 Subject: [PATCH] docs: optimizeForDisabled --- docs/usage/self-hosted-configuration.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/usage/self-hosted-configuration.md b/docs/usage/self-hosted-configuration.md index 08781cc1a3..e36fec8fd9 100644 --- a/docs/usage/self-hosted-configuration.md +++ b/docs/usage/self-hosted-configuration.md @@ -513,6 +513,17 @@ Similarly to `onboardingBranch`, if you have an existing Renovate installation a ## optimizeForDisabled +When this option is `true`, Renovate will do the following during repository initialization: + +- Attempt to fetch the default config file (`renovate.json`) +- Check if the file contains `"enabled": false` + +If the file exists and the config is disabled, Renovate will skip the repo without cloning it. +Otherwise, it will continue as normal. + +This option is only useful where the ratio of disabled repos is quite high. +It costs one extra API call per repo but has the benefit of skipping cloning of those which are disabled. + ## password ## persistRepoData -- GitLab