Skip to content

Commit

Permalink
docs(configuration options): rewrite branchNameStrict (#17305)
Browse files Browse the repository at this point in the history
  • Loading branch information
HonkingGoose committed Aug 22, 2022
1 parent 1a25ac6 commit 3db3d7c
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/usage/configuration-options.md
Expand Up @@ -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

Expand Down

0 comments on commit 3db3d7c

Please sign in to comment.