Skip to content

Commit a7a6e01

Browse files
committed
#4017 - Docs changes
1 parent b367b02 commit a7a6e01

File tree

1 file changed

+44
-11
lines changed

1 file changed

+44
-11
lines changed

docs/input/docs/reference/configuration.md

Lines changed: 44 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,9 @@ tag-prefix: '[abc]'
3838
3939
The built-in configuration for the `GitFlow` workflow (`workflow: GitFlow/v1`) looks like:
4040

41-
```yaml
41+
<!-- snippet: /docs/workflows/GitFlow/v1.yml -->
42+
<a id='snippet-/docs/workflows/GitFlow/v1.yml'></a>
43+
```yml
4244
assembly-versioning-scheme: MajorMinorPatch
4345
assembly-file-versioning-scheme: MajorMinorPatch
4446
tag-prefix: '[vV]?'
@@ -207,10 +209,14 @@ tracks-release-branches: false
207209
is-release-branch: false
208210
is-main-branch: false
209211
```
212+
<sup><a href='/docs/workflows/GitFlow/v1.yml#L1-L167' title='Snippet source file'>snippet source</a> | <a href='#snippet-/docs/workflows/GitFlow/v1.yml' title='Start of snippet'>anchor</a></sup>
213+
<!-- endSnippet -->
210214

211215
The supported built-in configuration for the `GitHubFlow` workflow (`workflow: GitHubFlow/v1`) looks like:
212216

213-
```yaml
217+
<!-- snippet: /docs/workflows/GitHubFlow/v1.yml -->
218+
<a id='snippet-/docs/workflows/GitHubFlow/v1.yml'></a>
219+
```yml
214220
assembly-versioning-scheme: MajorMinorPatch
215221
assembly-file-versioning-scheme: MajorMinorPatch
216222
tag-prefix: '[vV]?'
@@ -270,12 +276,12 @@ branches:
270276
increment: Inherit
271277
prevent-increment:
272278
when-current-commit-tagged: false
279+
track-merge-message: true
273280
regex: ^features?[/-](?<BranchName>.+)
274281
source-branches:
275282
- main
276283
- release
277284
is-source-branch-for: []
278-
track-merge-message: true
279285
is-main-branch: false
280286
pre-release-weight: 30000
281287
pull-request:
@@ -286,28 +292,28 @@ branches:
286292
of-merged-branch: true
287293
when-current-commit-tagged: false
288294
label-number-pattern: '[/-](?<number>\d+)'
295+
track-merge-message: true
289296
regex: ^(pull|pull\-requests|pr)[/-]
290297
source-branches:
291298
- main
292299
- release
293300
- feature
294301
is-source-branch-for: []
295-
track-merge-message: true
296302
pre-release-weight: 30000
297303
unknown:
298304
mode: ManualDeployment
299305
label: '{BranchName}'
300306
increment: Inherit
301307
prevent-increment:
302308
when-current-commit-tagged: false
309+
track-merge-message: false
303310
regex: (?<BranchName>.+)
304311
source-branches:
305312
- main
306313
- release
307314
- feature
308315
- pull-request
309316
is-source-branch-for: []
310-
track-merge-message: false
311317
is-main-branch: false
312318
ignore:
313319
sha: []
@@ -328,10 +334,14 @@ tracks-release-branches: false
328334
is-release-branch: false
329335
is-main-branch: false
330336
```
337+
<sup><a href='/docs/workflows/GitHubFlow/v1.yml#L1-L116' title='Snippet source file'>snippet source</a> | <a href='#snippet-/docs/workflows/GitHubFlow/v1.yml' title='Start of snippet'>anchor</a></sup>
338+
<!-- endSnippet -->
331339

332340
The preview built-in configuration (experimental usage only) for the `TrunkBased` workflow (`workflow: TrunkBased/preview1`) looks like:
333341

334-
```yaml
342+
<!-- snippet: /docs/workflows/TrunkBased/preview1.yml -->
343+
<a id='snippet-/docs/workflows/TrunkBased/preview1.yml'></a>
344+
```yml
335345
assembly-versioning-scheme: MajorMinorPatch
336346
assembly-file-versioning-scheme: MajorMinorPatch
337347
tag-prefix: '[vV]?'
@@ -346,55 +356,74 @@ merge-message-formats: {}
346356
update-build-number: true
347357
semantic-version-format: Strict
348358
strategies:
349-
- Mainline
350359
- ConfiguredNextVersion
360+
- Mainline
351361
branches:
352362
main:
353363
mode: ContinuousDeployment
354364
label: ''
355365
increment: Patch
356366
prevent-increment:
357367
of-merged-branch: true
358-
when-current-commit-tagged: true
359368
track-merge-target: false
369+
track-merge-message: true
360370
regex: ^master$|^main$
361371
source-branches: []
372+
is-source-branch-for: []
362373
tracks-release-branches: false
363374
is-release-branch: false
364375
is-main-branch: true
365376
pre-release-weight: 55000
366377
feature:
378+
mode: ContinuousDelivery
379+
label: '{BranchName}'
367380
increment: Minor
368-
regex: ^features?[/-](?<BranchName>.+)
369381
prevent-increment:
370382
when-current-commit-tagged: false
383+
track-merge-message: true
384+
regex: ^features?[/-](?<BranchName>.+)
371385
source-branches:
372386
- main
387+
is-source-branch-for: []
388+
is-main-branch: false
373389
pre-release-weight: 30000
374390
hotfix:
391+
mode: ContinuousDelivery
392+
label: '{BranchName}'
375393
increment: Patch
376-
regex: ^hotfix(es)?[/-](?<BranchName>.+)
377394
prevent-increment:
378395
when-current-commit-tagged: false
396+
regex: ^hotfix(es)?[/-](?<BranchName>.+)
379397
source-branches:
380398
- main
399+
is-source-branch-for: []
400+
is-release-branch: true
401+
is-main-branch: false
381402
pre-release-weight: 30000
382403
pull-request:
383404
mode: ContinuousDelivery
384405
label: PullRequest
385406
increment: Inherit
407+
prevent-increment:
408+
of-merged-branch: true
409+
when-current-commit-tagged: false
386410
label-number-pattern: '[/-](?<number>\d+)'
411+
track-merge-message: true
387412
regex: ^(pull|pull\-requests|pr)[/-]
388413
source-branches:
389414
- main
415+
- feature
416+
- hotfix
417+
is-source-branch-for: []
390418
pre-release-weight: 30000
391419
unknown:
392420
increment: Patch
393-
regex: (?<BranchName>.+)
394421
prevent-increment:
395422
when-current-commit-tagged: false
423+
regex: (?<BranchName>.+)
396424
source-branches:
397425
- main
426+
is-source-branch-for: []
398427
pre-release-weight: 30000
399428
ignore:
400429
sha: []
@@ -409,10 +438,14 @@ track-merge-target: false
409438
track-merge-message: true
410439
commit-message-incrementing: Enabled
411440
regex: ''
441+
source-branches: []
442+
is-source-branch-for: []
412443
tracks-release-branches: false
413444
is-release-branch: false
414445
is-main-branch: false
415446
```
447+
<sup><a href='/docs/workflows/TrunkBased/preview1.yml#L1-L101' title='Snippet source file'>snippet source</a> | <a href='#snippet-/docs/workflows/TrunkBased/preview1.yml' title='Start of snippet'>anchor</a></sup>
448+
<!-- endSnippet -->
416449

417450
The details of the available options are as follows:
418451

0 commit comments

Comments
 (0)