renovate/renovate
1
0
Fork 0
mirror of https://github.com/renovatebot/renovate.git synced 2025-01-12 15:06:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

docs(config options): rewrite additionalBranchPrefix (#18227)

Browse source 
Co-authored-by: Rhys Arkins <rhys@arkins.net>
This commit is contained in:
HonkingGoose 2022-10-11 08:36:17 +02:00 committed by GitHub
parent 7935a7b8ed
commit c3a87b687e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/usage/configuration-options.md
View file

@ -79,9 +79,12 @@ With the above config:
## additionalBranchPrefix ## additionalBranchPrefix
This value defaults to an empty string, and is typically not necessary. By default, the value for this config option is an empty string.
Some managers previously populated this field, but they no longer do so by default. Normally you don't need to set this config option.
You normally don't need to configure this, but one example where it can be useful is combining with `parentDir` in monorepos to split PRs based on where the package definition is located, e.g.
Here's an example where `additionalBranchPrefix` can help you.
Say you're using a monorepo and want to split pull requests based on the location of the package definition, so that individual teams can manage their own Renovate pull requests.
This can be done with this configuration:
```json ```json
{ {