@@ -37,12 +37,11 @@ To see the effective configuration (defaults and overrides), you can run
3737The following supported workflow configurations are available in GitVersion and can be referenced by the workflow property:
3838- GitFlow (GitFlow/v1)
3939- GitHubFlow (GitHubFlow/v1)
40- - TrunkBased (TrunkBased/v1)
4140
4241Example of using a ` TrunkBased ` workflow with a different ` tag-prefix ` :
4342
4443``` yaml
45- workflow : TrunkBased /v1
44+ workflow : GitHubFlow /v1
4645tag-prefix : ' [abc]'
4746` ` `
4847
@@ -76,8 +75,10 @@ branches:
7675 prevent-increment:
7776 when-current-commit-tagged: false
7877 track-merge-target: true
78+ track-merge-message: true
7979 regex: ^dev(elop)?(ment)?$
80- source-branches: []
80+ source-branches:
81+ - main
8182 is-source-branch-for: []
8283 tracks-release-branches: true
8384 is-release-branch: false
@@ -89,10 +90,9 @@ branches:
8990 prevent-increment:
9091 of-merged-branch: true
9192 track-merge-target: false
93+ track-merge-message: true
9294 regex: ^master$|^main$
93- source-branches:
94- - develop
95- - release
95+ source-branches: []
9696 is-source-branch-for: []
9797 tracks-release-branches: false
9898 is-release-branch: false
@@ -101,17 +101,15 @@ branches:
101101 release:
102102 mode: ManualDeployment
103103 label: beta
104- increment: None
104+ increment: Minor
105105 prevent-increment:
106106 of-merged-branch: true
107107 when-current-commit-tagged: false
108108 track-merge-target: false
109109 regex: ^releases?[/-](?<BranchName>.+)
110110 source-branches:
111- - develop
112111 - main
113112 - support
114- - release
115113 is-source-branch-for: []
116114 tracks-release-branches: false
117115 is-release-branch: true
@@ -121,23 +119,28 @@ branches:
121119 mode: ManualDeployment
122120 label: '{BranchName}'
123121 increment: Inherit
124- prevent-increment: {}
122+ prevent-increment:
123+ when-current-commit-tagged: false
124+ track-merge-message: true
125125 regex: ^features?[/-](?<BranchName>.+)
126126 source-branches:
127127 - develop
128128 - main
129129 - release
130- - feature
131130 - support
132131 - hotfix
133132 is-source-branch-for: []
133+ is-main-branch: false
134134 pre-release-weight: 30000
135135 pull-request:
136136 mode: ContinuousDelivery
137137 label: PullRequest
138138 increment: Inherit
139- prevent-increment: {}
139+ prevent-increment:
140+ of-merged-branch: true
141+ when-current-commit-tagged: false
140142 label-number-pattern: '[/-](?<number>\d +)'
143+ track-merge-message: true
141144 regex: ^(pull|pull\- requests|pr)[/-]
142145 source-branches:
143146 - develop
@@ -156,12 +159,11 @@ branches:
156159 when-current-commit-tagged: false
157160 regex: ^hotfix(es)?[/-](?<BranchName>.+)
158161 source-branches:
159- - release
160162 - main
161163 - support
162- - hotfix
163164 is-source-branch-for: []
164165 is-release-branch: true
166+ is-main-branch: false
165167 pre-release-weight: 30000
166168 support:
167169 label: ''
@@ -181,7 +183,8 @@ branches:
181183 mode: ManualDeployment
182184 label: '{BranchName}'
183185 increment: Inherit
184- prevent-increment: {}
186+ prevent-increment:
187+ when-current-commit-tagged: true
185188 regex: (?<BranchName>.+)
186189 source-branches:
187190 - main
@@ -192,6 +195,7 @@ branches:
192195 - hotfix
193196 - support
194197 is-source-branch-for: []
198+ is-main-branch: false
195199ignore:
196200 sha: []
197201mode: ContinuousDelivery
@@ -241,10 +245,10 @@ branches:
241245 increment: Patch
242246 prevent-increment:
243247 of-merged-branch: true
244- track-merge-target: false
248+ tracks-merge-target: false
249+ tracks-merge-message: true
245250 regex: ^master$|^main$
246- source-branches:
247- - release
251+ source-branches: []
248252 is-source-branch-for: []
249253 tracks-release-branches: false
250254 is-release-branch: false
@@ -253,15 +257,16 @@ branches:
253257 release:
254258 mode: ManualDeployment
255259 label: beta
256- increment: None
260+ increment: Patch
257261 prevent-increment:
258262 of-merged-branch: true
263+ when-branch-merged: false
259264 when-current-commit-tagged: false
260265 track-merge-target: false
266+ track-merge-message: true
261267 regex: ^releases?[/-](?<BranchName>.+)
262268 source-branches:
263269 - main
264- - release
265270 is-source-branch-for: []
266271 tracks-release-branches: false
267272 is-release-branch: true
@@ -271,36 +276,47 @@ branches:
271276 mode: ManualDeployment
272277 label: '{BranchName}'
273278 increment: Inherit
279+ prevent-increment:
280+ when-current-commit-tagged: false
274281 regex: ^features?[/-](?<BranchName>.+)
275282 source-branches:
276283 - main
277284 - release
278- - feature
279285 is-source-branch-for: []
286+ track-merge-message: true
287+ is-main-branch: false
280288 pre-release-weight: 30000
281289 pull-request:
282290 mode: ContinuousDelivery
283291 label: PullRequest
284292 increment: Inherit
293+ prevent-increment:
294+ of-merged-branch: true
295+ when-current-commit-tagged: false
285296 label-number-pattern: '[/-](?<number>\d +)'
286297 regex: ^(pull|pull\- requests|pr)[/-]
287298 source-branches:
288299 - main
289300 - release
290301 - feature
291302 is-source-branch-for: []
303+ track-merge-message: true
292304 pre-release-weight: 30000
293305 unknown:
294306 mode: ManualDeployment
295307 label: '{BranchName}'
296308 increment: Inherit
309+ prevent-increment:
310+ when-current-commit-tagged: false
297311 regex: (?<BranchName>.+)
298312 source-branches:
299313 - main
300314 - release
301315 - feature
302316 - pull-request
303317 is-source-branch-for: []
318+ track-merge-message: false
319+ is-main-branch: false
304320ignore:
305321 sha: []
306322mode: ContinuousDelivery
@@ -321,96 +337,11 @@ is-release-branch: false
321337is-main-branch: false
322338` ` `
323339
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-
409340The details of the available options are as follows :
410341
411342# ## workflow
412343
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 .
414345
415346# ## next-version
416347
0 commit comments