@@ -37,12 +37,11 @@ To see the effective configuration (defaults and overrides), you can run
37
37
The following supported workflow configurations are available in GitVersion and can be referenced by the workflow property:
38
38
- GitFlow (GitFlow/v1)
39
39
- GitHubFlow (GitHubFlow/v1)
40
- - TrunkBased (TrunkBased/v1)
41
40
42
41
Example of using a ` TrunkBased ` workflow with a different ` tag-prefix ` :
43
42
44
43
``` yaml
45
- workflow : TrunkBased /v1
44
+ workflow : GitHubFlow /v1
46
45
tag-prefix : ' [abc]'
47
46
` ` `
48
47
@@ -76,8 +75,10 @@ branches:
76
75
prevent-increment:
77
76
when-current-commit-tagged: false
78
77
track-merge-target: true
78
+ track-merge-message: true
79
79
regex: ^dev(elop)?(ment)?$
80
- source-branches: []
80
+ source-branches:
81
+ - main
81
82
is-source-branch-for: []
82
83
tracks-release-branches: true
83
84
is-release-branch: false
@@ -89,10 +90,9 @@ branches:
89
90
prevent-increment:
90
91
of-merged-branch: true
91
92
track-merge-target: false
93
+ track-merge-message: true
92
94
regex: ^master$|^main$
93
- source-branches:
94
- - develop
95
- - release
95
+ source-branches: []
96
96
is-source-branch-for: []
97
97
tracks-release-branches: false
98
98
is-release-branch: false
@@ -101,17 +101,15 @@ branches:
101
101
release:
102
102
mode: ManualDeployment
103
103
label: beta
104
- increment: None
104
+ increment: Minor
105
105
prevent-increment:
106
106
of-merged-branch: true
107
107
when-current-commit-tagged: false
108
108
track-merge-target: false
109
109
regex: ^releases?[/-](?<BranchName>.+)
110
110
source-branches:
111
- - develop
112
111
- main
113
112
- support
114
- - release
115
113
is-source-branch-for: []
116
114
tracks-release-branches: false
117
115
is-release-branch: true
@@ -121,23 +119,28 @@ branches:
121
119
mode: ManualDeployment
122
120
label: '{BranchName}'
123
121
increment: Inherit
124
- prevent-increment: {}
122
+ prevent-increment:
123
+ when-current-commit-tagged: false
124
+ track-merge-message: true
125
125
regex: ^features?[/-](?<BranchName>.+)
126
126
source-branches:
127
127
- develop
128
128
- main
129
129
- release
130
- - feature
131
130
- support
132
131
- hotfix
133
132
is-source-branch-for: []
133
+ is-main-branch: false
134
134
pre-release-weight: 30000
135
135
pull-request:
136
136
mode: ContinuousDelivery
137
137
label: PullRequest
138
138
increment: Inherit
139
- prevent-increment: {}
139
+ prevent-increment:
140
+ of-merged-branch: true
141
+ when-current-commit-tagged: false
140
142
label-number-pattern: '[/-](?<number>\d +)'
143
+ track-merge-message: true
141
144
regex: ^(pull|pull\- requests|pr)[/-]
142
145
source-branches:
143
146
- develop
@@ -156,12 +159,11 @@ branches:
156
159
when-current-commit-tagged: false
157
160
regex: ^hotfix(es)?[/-](?<BranchName>.+)
158
161
source-branches:
159
- - release
160
162
- main
161
163
- support
162
- - hotfix
163
164
is-source-branch-for: []
164
165
is-release-branch: true
166
+ is-main-branch: false
165
167
pre-release-weight: 30000
166
168
support:
167
169
label: ''
@@ -181,7 +183,8 @@ branches:
181
183
mode: ManualDeployment
182
184
label: '{BranchName}'
183
185
increment: Inherit
184
- prevent-increment: {}
186
+ prevent-increment:
187
+ when-current-commit-tagged: true
185
188
regex: (?<BranchName>.+)
186
189
source-branches:
187
190
- main
@@ -192,6 +195,7 @@ branches:
192
195
- hotfix
193
196
- support
194
197
is-source-branch-for: []
198
+ is-main-branch: false
195
199
ignore:
196
200
sha: []
197
201
mode: ContinuousDelivery
@@ -241,10 +245,10 @@ branches:
241
245
increment: Patch
242
246
prevent-increment:
243
247
of-merged-branch: true
244
- track-merge-target: false
248
+ tracks-merge-target: false
249
+ tracks-merge-message: true
245
250
regex: ^master$|^main$
246
- source-branches:
247
- - release
251
+ source-branches: []
248
252
is-source-branch-for: []
249
253
tracks-release-branches: false
250
254
is-release-branch: false
@@ -253,15 +257,16 @@ branches:
253
257
release:
254
258
mode: ManualDeployment
255
259
label: beta
256
- increment: None
260
+ increment: Patch
257
261
prevent-increment:
258
262
of-merged-branch: true
263
+ when-branch-merged: false
259
264
when-current-commit-tagged: false
260
265
track-merge-target: false
266
+ track-merge-message: true
261
267
regex: ^releases?[/-](?<BranchName>.+)
262
268
source-branches:
263
269
- main
264
- - release
265
270
is-source-branch-for: []
266
271
tracks-release-branches: false
267
272
is-release-branch: true
@@ -271,36 +276,47 @@ branches:
271
276
mode: ManualDeployment
272
277
label: '{BranchName}'
273
278
increment: Inherit
279
+ prevent-increment:
280
+ when-current-commit-tagged: false
274
281
regex: ^features?[/-](?<BranchName>.+)
275
282
source-branches:
276
283
- main
277
284
- release
278
- - feature
279
285
is-source-branch-for: []
286
+ track-merge-message: true
287
+ is-main-branch: false
280
288
pre-release-weight: 30000
281
289
pull-request:
282
290
mode: ContinuousDelivery
283
291
label: PullRequest
284
292
increment: Inherit
293
+ prevent-increment:
294
+ of-merged-branch: true
295
+ when-current-commit-tagged: false
285
296
label-number-pattern: '[/-](?<number>\d +)'
286
297
regex: ^(pull|pull\- requests|pr)[/-]
287
298
source-branches:
288
299
- main
289
300
- release
290
301
- feature
291
302
is-source-branch-for: []
303
+ track-merge-message: true
292
304
pre-release-weight: 30000
293
305
unknown:
294
306
mode: ManualDeployment
295
307
label: '{BranchName}'
296
308
increment: Inherit
309
+ prevent-increment:
310
+ when-current-commit-tagged: false
297
311
regex: (?<BranchName>.+)
298
312
source-branches:
299
313
- main
300
314
- release
301
315
- feature
302
316
- pull-request
303
317
is-source-branch-for: []
318
+ track-merge-message: false
319
+ is-main-branch: false
304
320
ignore:
305
321
sha: []
306
322
mode: ContinuousDelivery
@@ -321,96 +337,11 @@ is-release-branch: false
321
337
is-main-branch: false
322
338
` ` `
323
339
324
- The supported built-in configuration for the `TrunkBased` workflow (`workflow : TrunkBased/v1`) looks like:
325
-
326
- ` ` ` yaml
327
- assembly-versioning-scheme: MajorMinorPatch
328
- assembly-file-versioning-scheme: MajorMinorPatch
329
- tag-prefix: '[vV]?'
330
- version-in-branch-pattern: (?<version>[vV]?\d +(\.\d +)?(\.\d +)?).*
331
- major-version-bump-message: '\+ semver:\s ?(breaking|major)'
332
- minor-version-bump-message: '\+ semver:\s ?(feature|minor)'
333
- patch-version-bump-message: '\+ semver:\s ?(fix|patch)'
334
- no-bump-message: '\+ semver:\s ?(none|skip)'
335
- tag-pre-release-weight: 60000
336
- commit-date-format: yyyy-MM-dd
337
- merge-message-formats: {}
338
- update-build-number: true
339
- semantic-version-format: Strict
340
- strategies:
341
- - TrunkBased
342
- - ConfiguredNextVersion
343
- branches:
344
- main:
345
- mode: ContinuousDeployment
346
- label: ''
347
- increment: Patch
348
- prevent-increment:
349
- of-merged-branch: true
350
- track-merge-target: false
351
- regex: ^master$|^main$
352
- source-branches: []
353
- tracks-release-branches: false
354
- is-release-branch: false
355
- is-main-branch: true
356
- pre-release-weight: 55000
357
- feature:
358
- increment: Minor
359
- regex: ^features?[/-](?<BranchName>.+)
360
- prevent-increment:
361
- when-current-commit-tagged: false
362
- source-branches:
363
- - main
364
- pre-release-weight: 30000
365
- hotfix:
366
- increment: Patch
367
- regex: ^hotfix(es)?[/-](?<BranchName>.+)
368
- prevent-increment:
369
- when-current-commit-tagged: false
370
- source-branches:
371
- - main
372
- pre-release-weight: 30000
373
- pull-request:
374
- mode: ContinuousDelivery
375
- label: PullRequest
376
- increment: Inherit
377
- label-number-pattern: '[/-](?<number>\d +)'
378
- regex: ^(pull|pull\- requests|pr)[/-]
379
- source-branches:
380
- - main
381
- pre-release-weight: 30000
382
- unknown:
383
- increment: Patch
384
- regex: (?<BranchName>.+)
385
- prevent-increment:
386
- when-current-commit-tagged: false
387
- source-branches:
388
- - main
389
- pre-release-weight: 30000
390
- ignore:
391
- sha: []
392
- mode: ContinuousDelivery
393
- label: '{BranchName}'
394
- increment: Inherit
395
- prevent-increment:
396
- of-merged-branch: false
397
- when-branch-merged: false
398
- when-current-commit-tagged: true
399
- track-merge-target: false
400
- track-merge-message: true
401
- commit-message-incrementing: Enabled
402
- regex: ''
403
- tracks-release-branches: false
404
- is-release-branch: false
405
- is-main-branch: false
406
-
407
- ` ` `
408
-
409
340
The details of the available options are as follows :
410
341
411
342
# ## workflow
412
343
413
- The base template of the configuration to use. Possible values are : GitFlow/v1 or GitHubFlow/v1 or TrunkBased/v1 . Defaults to GitFlow/v1 if not set.
344
+ The base template of the configuration to use. Possible values are : GitFlow/v1 or GitHubFlow/v1. Defaults to GitFlow/v1 if not set. To create a configuration from scratch without using a base template please specify an empty string .
414
345
415
346
# ## next-version
416
347
0 commit comments