Skip to content
Snippets Groups Projects
Unverified Commit 42bef1e9 authored by HonkingGoose's avatar HonkingGoose Committed by GitHub
Browse files

docs: improve branchConcurrentLimit documentation (#11879)

parent f25a05fa
No related branches found
No related tags found
No related merge requests found
......@@ -248,10 +248,11 @@ Configuring this to `true` means that Renovate will detect and apply the default
## branchConcurrentLimit
By default, Renovate won't enforce any concurrent branch limits. If you want the same limit for both concurrent branches
and concurrent PRs, then just set a value for `prConcurrentLimit` and it will be reused for branch calculations too.
However, if you want to allow more concurrent branches than concurrent PRs, you can configure both values (
e.g. `branchConcurrentLimit=5` and `prConcurrentLimit=3`).
By default, Renovate won't enforce any concurrent branch limits.
The `config:base` preset that many extend from limits the amount of concurrent branches to 20, but in most cases we would recommend lower values such as 5 or 10.
If you want the same limit for both concurrent branches and concurrent PRs, then just set a value for `prConcurrentLimit` and it will be reused for branch calculations too.
However, if you want to allow more concurrent branches than concurrent PRs, you can configure both values (e.g. `branchConcurrentLimit=5` and `prConcurrentLimit=3`).
This limit is enforced on a per-repository basis.
......@@ -263,6 +264,15 @@ 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`.
If you have too many concurrent branches which rebase themselves each run, Renovate can take a lot of time to rebase.
Solutions:
- Decrease the concurrent branch limit (note: this won't go and delete any existing, so won't have an effect until you either merge or close existing ones manually)
- Remove automerge and/or automatic rebasing (set `rebaseWhen` to `conflicted`). However if you have branch protection saying PRs must be up to date then it's not ideal to remove automatic rebasing
## branchName
Warning: it's strongly recommended not to configure this field directly.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment