Skip to content

Commit 26b5465

Browse files
committed
Change documentation
1 parent d54cd69 commit 26b5465

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

docs/input/docs/reference/configuration.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The global configuration looks like this:
4343
assembly-versioning-scheme: MajorMinorPatch
4444
assembly-file-versioning-scheme: MajorMinorPatch
4545
label-prefix: '[vV]?'
46-
version-in-branch-pattern: '(?<version>[vV]?\d+(\.\d+)?(\.\d+)?).*'
46+
version-in-branch-pattern: (?<version>[vV]?\d+(\.\d+)?(\.\d+)?).*
4747
major-version-bump-message: '\+semver:\s?(breaking|major)'
4848
minor-version-bump-message: '\+semver:\s?(feature|minor)'
4949
patch-version-bump-message: '\+semver:\s?(fix|patch)'
@@ -62,6 +62,7 @@ branches:
6262
track-merge-target: true
6363
regex: ^dev(elop)?(ment)?$
6464
source-branches: []
65+
is-source-branch-for: []
6566
tracks-release-branches: true
6667
is-release-branch: false
6768
is-mainline: false
@@ -75,6 +76,7 @@ branches:
7576
source-branches:
7677
- develop
7778
- release
79+
is-source-branch-for: []
7880
tracks-release-branches: false
7981
is-release-branch: false
8082
is-mainline: true
@@ -90,6 +92,7 @@ branches:
9092
- main
9193
- support
9294
- release
95+
is-source-branch-for: []
9396
tracks-release-branches: false
9497
is-release-branch: true
9598
is-mainline: false
@@ -106,6 +109,7 @@ branches:
106109
- feature
107110
- support
108111
- hotfix
112+
is-source-branch-for: []
109113
pre-release-weight: 30000
110114
pull-request:
111115
mode: ContinuousDelivery
@@ -120,6 +124,7 @@ branches:
120124
- feature
121125
- support
122126
- hotfix
127+
is-source-branch-for: []
123128
pre-release-weight: 30000
124129
hotfix:
125130
mode: ContinuousDelivery
@@ -131,6 +136,8 @@ branches:
131136
- main
132137
- support
133138
- hotfix
139+
is-source-branch-for: []
140+
is-release-branch: true
134141
pre-release-weight: 30000
135142
support:
136143
label: ''
@@ -140,6 +147,7 @@ branches:
140147
regex: ^support[/-]
141148
source-branches:
142149
- main
150+
is-source-branch-for: []
143151
tracks-release-branches: false
144152
is-release-branch: false
145153
is-mainline: true
@@ -157,6 +165,7 @@ branches:
157165
- pull-request
158166
- hotfix
159167
- support
168+
is-source-branch-for: []
160169
ignore:
161170
sha: []
162171
mode: ContinuousDelivery
@@ -167,6 +176,8 @@ track-merge-target: false
167176
track-merge-message: true
168177
commit-message-incrementing: Enabled
169178
regex: ''
179+
source-branches: []
180+
is-source-branch-for: []
170181
tracks-release-branches: false
171182
is-release-branch: false
172183
is-mainline: false
@@ -259,12 +270,15 @@ and [tracks-release-branches](#tracks-release-branches).
259270

260271
### label-prefix
261272

262-
A regular expression which is used to trim Git tags before processing (e.g., v1.0.0). The default value is `[vV]`.
273+
A regular expression which is used to trim Git tags before processing (e.g.,
274+
v1.0.0). The default value is `[vV]`.
263275

264276
### version-in-branch-pattern
265277

266-
A regular expression which is used to determine the version number in the branch name or commit message (e.g., v1.0.0-LTS).
267-
The default value is `(?<version>[vV]?\d+(\.\d+)?(\.\d+)?).*`.
278+
A regular expression which is used to determine the version number in the branch
279+
name or commit message (e.g., v1.0.0-LTS). This setting only applies on branches
280+
where the option `is-release-branch` is set to `true`. The default value is
281+
`(?<version>[vV]?\d+(\.\d+)?(\.\d+)?).*`.
268282

269283
### major-version-bump-message
270284

0 commit comments

Comments
 (0)