Skip to content

Commit efc9990

Browse files
committed
GitTools#4017 - Docs changes
1 parent 4b785fb commit efc9990

File tree

1 file changed

+51
-11
lines changed

1 file changed

+51
-11
lines changed

docs/input/docs/reference/configuration.md

Lines changed: 51 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
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+
18
---
29
Order: 10
310
Title: Configuration
@@ -48,7 +55,9 @@ tag-prefix: '[abc]'
4855
4956
The built-in configuration for the `GitFlow` workflow (`workflow: GitFlow/v1`) looks like:
5057

51-
```yaml
58+
<!-- snippet: input/docs/workflows/GitFlow/v1.yml -->
59+
<a id='snippet-input/docs/workflows/GitFlow/v1.yml'></a>
60+
```yml
5261
assembly-versioning-scheme: MajorMinorPatch
5362
assembly-file-versioning-scheme: MajorMinorPatch
5463
tag-prefix: '[vV]?'
@@ -217,10 +226,14 @@ tracks-release-branches: false
217226
is-release-branch: false
218227
is-main-branch: false
219228
```
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 -->
220231

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

223-
```yaml
234+
<!-- snippet: input/docs/workflows/GitHubFlow/v1.yml -->
235+
<a id='snippet-input/docs/workflows/GitHubFlow/v1.yml'></a>
236+
```yml
224237
assembly-versioning-scheme: MajorMinorPatch
225238
assembly-file-versioning-scheme: MajorMinorPatch
226239
tag-prefix: '[vV]?'
@@ -280,12 +293,12 @@ branches:
280293
increment: Inherit
281294
prevent-increment:
282295
when-current-commit-tagged: false
296+
track-merge-message: true
283297
regex: ^features?[/-](?<BranchName>.+)
284298
source-branches:
285299
- main
286300
- release
287301
is-source-branch-for: []
288-
track-merge-message: true
289302
is-main-branch: false
290303
pre-release-weight: 30000
291304
pull-request:
@@ -296,28 +309,28 @@ branches:
296309
of-merged-branch: true
297310
when-current-commit-tagged: false
298311
label-number-pattern: '[/-](?<number>\d+)'
312+
track-merge-message: true
299313
regex: ^(pull|pull\-requests|pr)[/-]
300314
source-branches:
301315
- main
302316
- release
303317
- feature
304318
is-source-branch-for: []
305-
track-merge-message: true
306319
pre-release-weight: 30000
307320
unknown:
308321
mode: ManualDeployment
309322
label: '{BranchName}'
310323
increment: Inherit
311324
prevent-increment:
312325
when-current-commit-tagged: false
326+
track-merge-message: false
313327
regex: (?<BranchName>.+)
314328
source-branches:
315329
- main
316330
- release
317331
- feature
318332
- pull-request
319333
is-source-branch-for: []
320-
track-merge-message: false
321334
is-main-branch: false
322335
ignore:
323336
sha: []
@@ -338,10 +351,14 @@ tracks-release-branches: false
338351
is-release-branch: false
339352
is-main-branch: false
340353
```
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 -->
341356

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

344-
```yaml
359+
<!-- snippet: input/docs/workflows/TrunkBased/preview1.yml -->
360+
<a id='snippet-input/docs/workflows/TrunkBased/preview1.yml'></a>
361+
```yml
345362
assembly-versioning-scheme: MajorMinorPatch
346363
assembly-file-versioning-scheme: MajorMinorPatch
347364
tag-prefix: '[vV]?'
@@ -356,55 +373,74 @@ merge-message-formats: {}
356373
update-build-number: true
357374
semantic-version-format: Strict
358375
strategies:
359-
- Mainline
360376
- ConfiguredNextVersion
377+
- Mainline
361378
branches:
362379
main:
363380
mode: ContinuousDeployment
364381
label: ''
365382
increment: Patch
366383
prevent-increment:
367384
of-merged-branch: true
368-
when-current-commit-tagged: true
369385
track-merge-target: false
386+
track-merge-message: true
370387
regex: ^master$|^main$
371388
source-branches: []
389+
is-source-branch-for: []
372390
tracks-release-branches: false
373391
is-release-branch: false
374392
is-main-branch: true
375393
pre-release-weight: 55000
376394
feature:
395+
mode: ContinuousDelivery
396+
label: '{BranchName}'
377397
increment: Minor
378-
regex: ^features?[/-](?<BranchName>.+)
379398
prevent-increment:
380399
when-current-commit-tagged: false
400+
track-merge-message: true
401+
regex: ^features?[/-](?<BranchName>.+)
381402
source-branches:
382403
- main
404+
is-source-branch-for: []
405+
is-main-branch: false
383406
pre-release-weight: 30000
384407
hotfix:
408+
mode: ContinuousDelivery
409+
label: '{BranchName}'
385410
increment: Patch
386-
regex: ^hotfix(es)?[/-](?<BranchName>.+)
387411
prevent-increment:
388412
when-current-commit-tagged: false
413+
regex: ^hotfix(es)?[/-](?<BranchName>.+)
389414
source-branches:
390415
- main
416+
is-source-branch-for: []
417+
is-release-branch: true
418+
is-main-branch: false
391419
pre-release-weight: 30000
392420
pull-request:
393421
mode: ContinuousDelivery
394422
label: PullRequest
395423
increment: Inherit
424+
prevent-increment:
425+
of-merged-branch: true
426+
when-current-commit-tagged: false
396427
label-number-pattern: '[/-](?<number>\d+)'
428+
track-merge-message: true
397429
regex: ^(pull|pull\-requests|pr)[/-]
398430
source-branches:
399431
- main
432+
- feature
433+
- hotfix
434+
is-source-branch-for: []
400435
pre-release-weight: 30000
401436
unknown:
402437
increment: Patch
403-
regex: (?<BranchName>.+)
404438
prevent-increment:
405439
when-current-commit-tagged: false
440+
regex: (?<BranchName>.+)
406441
source-branches:
407442
- main
443+
is-source-branch-for: []
408444
pre-release-weight: 30000
409445
ignore:
410446
sha: []
@@ -419,10 +455,14 @@ track-merge-target: false
419455
track-merge-message: true
420456
commit-message-incrementing: Enabled
421457
regex: ''
458+
source-branches: []
459+
is-source-branch-for: []
422460
tracks-release-branches: false
423461
is-release-branch: false
424462
is-main-branch: false
425463
```
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 -->
426466

427467
The details of the available options are as follows:
428468

0 commit comments

Comments
 (0)