From 3db3d7c11ea0d4e0155c93d5158699c68df418fc Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Mon, 22 Aug 2022 11:21:03 +0200 Subject: [PATCH] docs(configuration options): rewrite `branchNameStrict` (#17305) --- docs/usage/configuration-options.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index 4c5bf2cb7c2184..1fdb5949fd2653 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -289,9 +289,14 @@ If you truly need to configure this then it probably means either: ## branchNameStrict -By default, Renovate does not use strict-mode when slugifying the branch name. This means that certain special characters such as `.` may end up within the branch name. +By default, Renovate doesn't care about special characters when slugifying the branch name. +This means that special characters like `.` may end up in the branch name. -By setting this configuration to `true`, all special characters will be removed from the branch name, resulting in a branch name consisting exclusively of alphabetic characters separated by `-`. +When you set `branchNameStrict` to `true`: + +- all special characters are removed +- only alphabetic characters are allowed +- hyphens `-` are used to separate sections ## branchPrefix