Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve branchConcurrentLimit documentation #11879

Merged
merged 4 commits into from
Sep 27, 2021
Merged

docs: improve branchConcurrentLimit documentation #11879

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1676b32
docs: improve branchConcurrentLimit documentation
HonkingGoose Sep 24, 2021
ba4173a
Apply suggestions from code review
HonkingGoose Sep 24, 2021
5b5aa3e
Remove punctuation at end of list item
HonkingGoose Sep 24, 2021
9568dc6
Merge branch 'main' into docs/based-on-discussion-11866
HonkingGoose Sep 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Apply suggestions from code review 
Co-authored-by: Rhys Arkins <rhys@arkins.net>
  • Loading branch information
@HonkingGoose @rarkins
HonkingGoose and rarkins authored Sep 24, 2021
commit ba4173aa10bf72ced48f2abdeae8575c64f8edd0
4 changes: 2 additions & 2 deletions docs/usage/configuration-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ Configuring this to `true` means that Renovate will detect and apply the default
## branchConcurrentLimit

By default, Renovate won't enforce any concurrent branch limits.
The `config:base` preset that many extend from limits the amount of concurrent branches.
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`).
Expand All @@ -264,7 +264,7 @@ Example config:
}
```

Warning: increasing the `branchConcurrentLimit` increases the time it takes for Renovate to complete rebasing a PR branch when it's behind the target branch.
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.
Expand Down