1
+ <!--
2
+ GENERATED FILE - DO NOT EDIT
3
+ This file was generated by [MarkdownSnippets](https://github.com/SimonCropp/MarkdownSnippets).
4
+ Source File: /docs/input/docs/reference/configuration.source.md
5
+ To change this file edit the source file and then run MarkdownSnippets.
6
+ -->
7
+
1
8
---
2
9
Order: 10
3
10
Title: Configuration
@@ -48,7 +55,9 @@ tag-prefix: '[abc]'
48
55
49
56
The built-in configuration for the ` GitFlow` workflow (`workflow: GitFlow/v1`) looks like:
50
57
51
- ` ` ` yaml
58
+ <!-- snippet : input/docs/workflows/GitFlow/v1.yml -->
59
+ <a id='snippet-input/docs/workflows/GitFlow/v1.yml'></a>
60
+ ` ` ` yml
52
61
assembly-versioning-scheme: MajorMinorPatch
53
62
assembly-file-versioning-scheme: MajorMinorPatch
54
63
tag-prefix: '[vV]?'
@@ -217,10 +226,14 @@ tracks-release-branches: false
217
226
is-release-branch: false
218
227
is-main-branch: false
219
228
` ` `
229
+ <sup><a href='/docs/input/docs/workflows/GitFlow/v1.yml#L1-L167' title='Snippet source file'>snippet source</a> | <a href='#snippet-input/docs/workflows/GitFlow/v1.yml' title='Start of snippet'>anchor</a></sup>
230
+ <!-- endSnippet -->
220
231
221
232
The supported built-in configuration for the `GitHubFlow` workflow (`workflow : GitHubFlow/v1`) looks like:
222
233
223
- ` ` ` yaml
234
+ <!-- snippet : input/docs/workflows/GitHubFlow/v1.yml -->
235
+ <a id='snippet-input/docs/workflows/GitHubFlow/v1.yml'></a>
236
+ ` ` ` yml
224
237
assembly-versioning-scheme: MajorMinorPatch
225
238
assembly-file-versioning-scheme: MajorMinorPatch
226
239
tag-prefix: '[vV]?'
@@ -280,12 +293,12 @@ branches:
280
293
increment: Inherit
281
294
prevent-increment:
282
295
when-current-commit-tagged: false
296
+ track-merge-message: true
283
297
regex: ^features?[/-](?<BranchName>.+)
284
298
source-branches:
285
299
- main
286
300
- release
287
301
is-source-branch-for: []
288
- track-merge-message: true
289
302
is-main-branch: false
290
303
pre-release-weight: 30000
291
304
pull-request:
@@ -296,28 +309,28 @@ branches:
296
309
of-merged-branch: true
297
310
when-current-commit-tagged: false
298
311
label-number-pattern: '[/-](?<number>\d +)'
312
+ track-merge-message: true
299
313
regex: ^(pull|pull\- requests|pr)[/-]
300
314
source-branches:
301
315
- main
302
316
- release
303
317
- feature
304
318
is-source-branch-for: []
305
- track-merge-message: true
306
319
pre-release-weight: 30000
307
320
unknown:
308
321
mode: ManualDeployment
309
322
label: '{BranchName}'
310
323
increment: Inherit
311
324
prevent-increment:
312
325
when-current-commit-tagged: false
326
+ track-merge-message: false
313
327
regex: (?<BranchName>.+)
314
328
source-branches:
315
329
- main
316
330
- release
317
331
- feature
318
332
- pull-request
319
333
is-source-branch-for: []
320
- track-merge-message: false
321
334
is-main-branch: false
322
335
ignore:
323
336
sha: []
@@ -338,10 +351,14 @@ tracks-release-branches: false
338
351
is-release-branch: false
339
352
is-main-branch: false
340
353
` ` `
354
+ <sup><a href='/docs/input/docs/workflows/GitHubFlow/v1.yml#L1-L116' title='Snippet source file'>snippet source</a> | <a href='#snippet-input/docs/workflows/GitHubFlow/v1.yml' title='Start of snippet'>anchor</a></sup>
355
+ <!-- endSnippet -->
341
356
342
357
The preview built-in configuration (experimental usage only) for the `TrunkBased` workflow (`workflow : TrunkBased/preview1`) looks like:
343
358
344
- ` ` ` yaml
359
+ <!-- snippet : input/docs/workflows/TrunkBased/preview1.yml -->
360
+ <a id='snippet-input/docs/workflows/TrunkBased/preview1.yml'></a>
361
+ ` ` ` yml
345
362
assembly-versioning-scheme: MajorMinorPatch
346
363
assembly-file-versioning-scheme: MajorMinorPatch
347
364
tag-prefix: '[vV]?'
@@ -356,55 +373,74 @@ merge-message-formats: {}
356
373
update-build-number: true
357
374
semantic-version-format: Strict
358
375
strategies:
359
- - Mainline
360
376
- ConfiguredNextVersion
377
+ - Mainline
361
378
branches:
362
379
main:
363
380
mode: ContinuousDeployment
364
381
label: ''
365
382
increment: Patch
366
383
prevent-increment:
367
384
of-merged-branch: true
368
- when-current-commit-tagged: true
369
385
track-merge-target: false
386
+ track-merge-message: true
370
387
regex: ^master$|^main$
371
388
source-branches: []
389
+ is-source-branch-for: []
372
390
tracks-release-branches: false
373
391
is-release-branch: false
374
392
is-main-branch: true
375
393
pre-release-weight: 55000
376
394
feature:
395
+ mode: ContinuousDelivery
396
+ label: '{BranchName}'
377
397
increment: Minor
378
- regex: ^features?[/-](?<BranchName>.+)
379
398
prevent-increment:
380
399
when-current-commit-tagged: false
400
+ track-merge-message: true
401
+ regex: ^features?[/-](?<BranchName>.+)
381
402
source-branches:
382
403
- main
404
+ is-source-branch-for: []
405
+ is-main-branch: false
383
406
pre-release-weight: 30000
384
407
hotfix:
408
+ mode: ContinuousDelivery
409
+ label: '{BranchName}'
385
410
increment: Patch
386
- regex: ^hotfix(es)?[/-](?<BranchName>.+)
387
411
prevent-increment:
388
412
when-current-commit-tagged: false
413
+ regex: ^hotfix(es)?[/-](?<BranchName>.+)
389
414
source-branches:
390
415
- main
416
+ is-source-branch-for: []
417
+ is-release-branch: true
418
+ is-main-branch: false
391
419
pre-release-weight: 30000
392
420
pull-request:
393
421
mode: ContinuousDelivery
394
422
label: PullRequest
395
423
increment: Inherit
424
+ prevent-increment:
425
+ of-merged-branch: true
426
+ when-current-commit-tagged: false
396
427
label-number-pattern: '[/-](?<number>\d +)'
428
+ track-merge-message: true
397
429
regex: ^(pull|pull\- requests|pr)[/-]
398
430
source-branches:
399
431
- main
432
+ - feature
433
+ - hotfix
434
+ is-source-branch-for: []
400
435
pre-release-weight: 30000
401
436
unknown:
402
437
increment: Patch
403
- regex: (?<BranchName>.+)
404
438
prevent-increment:
405
439
when-current-commit-tagged: false
440
+ regex: (?<BranchName>.+)
406
441
source-branches:
407
442
- main
443
+ is-source-branch-for: []
408
444
pre-release-weight: 30000
409
445
ignore:
410
446
sha: []
@@ -419,10 +455,14 @@ track-merge-target: false
419
455
track-merge-message: true
420
456
commit-message-incrementing: Enabled
421
457
regex: ''
458
+ source-branches: []
459
+ is-source-branch-for: []
422
460
tracks-release-branches: false
423
461
is-release-branch: false
424
462
is-main-branch: false
425
463
` ` `
464
+ <sup><a href='/docs/input/docs/workflows/TrunkBased/preview1.yml#L1-L101' title='Snippet source file'>snippet source</a> | <a href='#snippet-input/docs/workflows/TrunkBased/preview1.yml' title='Start of snippet'>anchor</a></sup>
465
+ <!-- endSnippet -->
426
466
427
467
The details of the available options are as follows :
428
468
0 commit comments