From c3a87b687ed44a1a100e0e4f91b81e22b7c32482 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Tue, 11 Oct 2022 08:36:17 +0200 Subject: [PATCH] docs(config options): rewrite additionalBranchPrefix (#18227) Co-authored-by: Rhys Arkins <rhys@arkins.net> --- docs/usage/configuration-options.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index 45df4cb548..70bbd84276 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -79,9 +79,12 @@ With the above config: ## additionalBranchPrefix -This value defaults to an empty string, and is typically not necessary. -Some managers previously populated this field, but they no longer do so by default. -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. +By default, the value for this config option is an empty string. +Normally you don't need to set this config option. + +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 { -- GitLab