From 7232f7149d902ef64b6da62b13b358afcd675f27 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Thu, 8 Sep 2022 13:50:55 +0200 Subject: [PATCH] docs(configuration options): rewrite prHourlyLimit (#17707) --- docs/usage/configuration-options.md | 30 ++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index 07f3fdfe92..113aab14e7 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -2158,20 +2158,28 @@ When you set prCreation to `not-pending` you're reducing the "noise" but get not ## prHourlyLimit -This setting - if enabled - helps slow down Renovate, particularly during the onboarding phase. What may happen without this setting is: +This config option slows down the _rate_ at which Renovate creates PRs. -1. Onboarding PR is created -2. User merges onboarding PR to activate Renovate -3. Renovate creates a "Pin Dependencies" PR (if necessary) -4. User merges Pin PR -5. Renovate then creates every single upgrade PR necessary - potentially dozens +Slowing Renovate down can be handy when you're onboarding a repository with a lot of dependencies. +What may happen if you don't set a `prHourlyLimit`: -The above can result in swamping CI systems, as well as a lot of retesting if branches need to be rebased every time one is merged. -Instead, if `prHourlyLimit` is configure to a value like 1 or 2, it will mean that Renovate creates at most that many new PRs within each hourly period (:00-:59). -So the project should still result in all PRs created perhaps within the first 24 hours maximum, but at a rate that may allow users to merge them once they pass tests. -It does not place a limit on the number of _concurrently open_ PRs - only on the rate they are created. +1. Renovate creates a Onboarding PR +1. You merge the onboarding PR to activate Renovate +1. Renovate creates a "Pin Dependencies" PR (if needed) +1. You merge the "Pin Dependencies" PR +1. Renovate creates every single upgrade PR needed, which can be a lot. This may cause: + - Renovate bot's PRs to overwhelm your CI systems + - a lot of test runs, because branches are rebased each time you merge a PR -This limit is enforced on a per-repository basis. +To prevent these problems you can set `prHourlyLimit` to a value like `1` or `2`. +Renovate will only create that many PRs within each hourly period (`:00` through `:59`). +You still get all the PRs in a reasonable time, perhaps over a day or so. +Now you can merge the PRs at a do-able rate, once the tests pass. + +<!-- prettier-ignore --> +!!! 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. ## prNotPendingHours -- GitLab