Skip to content

Commit eded73b

Browse files
HHobeckarturcic
HHobeck
authored and
arturcic
committed
Update documentation
1 parent dbed90b commit eded73b

File tree

2 files changed

+143
-123
lines changed

2 files changed

+143
-123
lines changed

‎docs/input/docs/reference/configuration.md

+73-63
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ tracks-release-branches: false
208208
is-release-branch: false
209209
is-main-branch: false
210210
```
211-
<sup><a href='/docs/workflows/GitFlow/v1.yml#L1-L166' title='Snippet source file'>snippet source</a> | <a href='#snippet-/docs/workflows/GitFlow/v1.yml' title='Start of snippet'>anchor</a></sup>
211+
<sup><a href='/docs/input/docs/workflows/GitFlow/v1.yml#L1-L166' title='Snippet source file'>snippet source</a> | <a href='#snippet-/docs/workflows/GitFlow/v1.yml' title='Start of snippet'>anchor</a></sup>
212212
<!-- endSnippet -->
213213

214214
The supported built-in configuration for the `GitHubFlow` workflow (`workflow: GitHubFlow/v1`) looks like:
@@ -332,7 +332,7 @@ tracks-release-branches: false
332332
is-release-branch: false
333333
is-main-branch: false
334334
```
335-
<sup><a href='/docs/workflows/GitHubFlow/v1.yml#L1-L115' title='Snippet source file'>snippet source</a> | <a href='#snippet-/docs/workflows/GitHubFlow/v1.yml' title='Start of snippet'>anchor</a></sup>
335+
<sup><a href='/docs/input/docs/workflows/GitHubFlow/v1.yml#L1-L115' title='Snippet source file'>snippet source</a> | <a href='#snippet-/docs/workflows/GitHubFlow/v1.yml' title='Start of snippet'>anchor</a></sup>
336336
<!-- endSnippet -->
337337

338338
The preview built-in configuration (experimental usage only) for the `TrunkBased` workflow (`workflow: TrunkBased/preview1`) looks like:
@@ -441,7 +441,7 @@ tracks-release-branches: false
441441
is-release-branch: false
442442
is-main-branch: false
443443
```
444-
<sup><a href='/docs/workflows/TrunkBased/preview1.yml#L1-L100' title='Snippet source file'>snippet source</a> | <a href='#snippet-/docs/workflows/TrunkBased/preview1.yml' title='Start of snippet'>anchor</a></sup>
444+
<sup><a href='/docs/input/docs/workflows/TrunkBased/preview1.yml#L1-L100' title='Snippet source file'>snippet source</a> | <a href='#snippet-/docs/workflows/TrunkBased/preview1.yml' title='Start of snippet'>anchor</a></sup>
445445
<!-- endSnippet -->
446446

447447
The details of the available options are as follows:
@@ -661,77 +661,84 @@ If you have branch specific configuration upgrading to v4 will force you to
661661
upgrade.
662662

663663
```yaml
664+
workflow: 'GitHubFlow/v1'
664665
branches:
665666
main:
666-
regex: ^master$|^main$
667-
mode: ContinuousDelivery
668667
label: ''
669668
increment: Patch
670-
prevent-increment-of-merged-branch-version: true
669+
prevent-increment:
670+
of-merged-branch: true
671671
track-merge-target: false
672-
source-branches: [ 'develop', 'release' ]
672+
track-merge-message: true
673+
regex: ^master$|^main$
674+
source-branches: []
675+
is-source-branch-for: []
673676
tracks-release-branches: false
674677
is-release-branch: false
675678
is-main-branch: true
676679
pre-release-weight: 55000
677-
develop:
678-
regex: ^dev(elop)?(ment)?$
679-
mode: ContinuousDeployment
680-
label: alpha
681-
increment: Minor
682-
prevent-increment-of-merged-branch-version: false
683-
track-merge-target: true
684-
source-branches: []
685-
tracks-release-branches: true
686-
is-release-branch: false
687-
is-main-branch: false
688-
pre-release-weight: 0
689680
release:
690-
regex: ^releases?[/-]
691-
mode: ContinuousDelivery
681+
mode: ManualDeployment
692682
label: beta
693-
increment: None
694-
prevent-increment-of-merged-branch-version: true
683+
increment: Patch
684+
prevent-increment:
685+
of-merged-branch: true
686+
when-branch-merged: false
687+
when-current-commit-tagged: false
695688
track-merge-target: false
696-
source-branches: [ 'develop', 'main', 'support', 'release' ]
689+
track-merge-message: true
690+
regex: ^releases?[\/-](?<BranchName>.+)
691+
source-branches:
692+
- main
693+
is-source-branch-for: []
697694
tracks-release-branches: false
698695
is-release-branch: true
699696
is-main-branch: false
700697
pre-release-weight: 30000
701698
feature:
702-
regex: ^features?[/-]
703-
mode: ContinuousDelivery
699+
mode: ManualDeployment
704700
label: '{BranchName}'
705701
increment: Inherit
706-
source-branches: [ 'develop', 'main', 'release', 'feature', 'support', 'hotfix' ]
702+
prevent-increment:
703+
when-current-commit-tagged: false
704+
track-merge-message: true
705+
regex: ^features?[\/-](?<BranchName>.+)
706+
source-branches:
707+
- main
708+
- release
709+
is-source-branch-for: []
710+
is-main-branch: false
707711
pre-release-weight: 30000
708712
pull-request:
709-
regex: ^(pull|pull\-requests|pr)[/-]
710713
mode: ContinuousDelivery
711-
label: PullRequest
714+
label: PullRequest{Number}
712715
increment: Inherit
713-
label-number-pattern: '[/-](?<number>\d+)[-/]'
714-
source-branches: [ 'develop', 'main', 'release', 'feature', 'support', 'hotfix' ]
716+
prevent-increment:
717+
of-merged-branch: true
718+
when-current-commit-tagged: false
719+
track-merge-message: true
720+
regex: ^(pull-requests|pull|pr)[\/-](?<Number>\d*)
721+
source-branches:
722+
- main
723+
- release
724+
- feature
725+
is-source-branch-for: []
715726
pre-release-weight: 30000
716-
hotfix:
717-
regex: ^hotfix(es)?[/-]
718-
mode: ContinuousDelivery
719-
label: beta
727+
unknown:
728+
mode: ManualDeployment
729+
label: '{BranchName}'
720730
increment: Inherit
721-
source-branches: [ 'release', 'main', 'support', 'hotfix' ]
722-
pre-release-weight: 30000
723-
support:
724-
regex: ^support[/-]
725-
mode: ContinuousDelivery
726-
label: ''
727-
increment: Patch
728-
prevent-increment-of-merged-branch-version: true
729-
track-merge-target: false
730-
source-branches: [ 'main' ]
731-
tracks-release-branches: false
732-
is-release-branch: false
733-
is-main-branch: true
734-
pre-release-weight: 55000
731+
prevent-increment:
732+
when-current-commit-tagged: false
733+
track-merge-message: false
734+
regex: (?<BranchName>.+)
735+
source-branches:
736+
- main
737+
- release
738+
- feature
739+
- pull-request
740+
is-source-branch-for: []
741+
is-main-branch: false
735742
```
736743

737744
If you don't specify the regex, the built-in for that branch config will be
@@ -837,9 +844,9 @@ The pre-release label to use for this branch. Use the value `{BranchName}` as a
837844
insert the value of the named group `BranchName` from the [regular expression](#regex).
838845

839846
For example: branch `feature/foo` would become a pre-release label
840-
of `alpha.foo` with `label: 'alpha.{BranchName}'` and `regex: '^features?[/-](?<BranchName>.+)'`.
847+
of `alpha.foo` with `label: 'alpha.{BranchName}'` and `regex: '^features?[\/-](?<BranchName>.+)'`.
841848

842-
Another example: branch `features/sc-12345/some-description` would become a pre-release label of `sc-12345` with `label: '{StoryNo}'` and `regex: '^features?[/-](?<StoryNo>sc-\d+)[-/].+'`.
849+
Another example: branch `features/sc-12345/some-description` would become a pre-release label of `sc-12345` with `label: '{StoryNo}'` and `regex: '^features?[\/-](?<StoryNo>sc-\d+)[-/].+'`.
843850

844851
**Note:** To clear a default use an empty string: `label: ''`
845852

@@ -871,25 +878,28 @@ This branch related property controls the behvior whether to use the tagged (val
871878
### label-number-pattern
872879

873880
Pull requests require us to extract the pre-release number out of the branch
874-
name so `refs/pulls/534/merge` builds as `PullRequest.534`. This is a regex with
875-
a named capture group called `number`.
876-
877-
If the branch `mode` is set to `ContinuousDeployment`, then the extracted
878-
`number` is appended to the name of the pre-release label and the number portion
879-
is the number of commits since the last label. This enables consecutive commits to
880-
the pull request branch to generate unique full semantic version numbers when
881-
the branch is configured to use ContinuousDeployment mode.
881+
name so `refs/pull/534/merge` builds as `PullRequest534`. This is a regex with
882+
a named capture group called `Number`.
882883

883884
**Example usage:**
884885

885886
```yaml
886887
branches:
887888
pull-request:
888-
mode: ContinuousDeployment
889-
label: PullRequest
889+
mode: ContinuousDelivery
890+
label: PullRequest{Number}
890891
increment: Inherit
891-
track-merge-target: true
892-
label-number-pattern: '[/-](?<number>\d+)[-/]'
892+
prevent-increment:
893+
of-merged-branch: true
894+
when-current-commit-tagged: false
895+
track-merge-message: true
896+
regex: ^(pull-requests|pull|pr)[\/-](?<Number>\d*)
897+
source-branches:
898+
- main
899+
- release
900+
- feature
901+
is-source-branch-for: []
902+
pre-release-weight: 30000
893903
```
894904

895905
### track-merge-target

‎docs/input/docs/reference/mdsource/configuration.source.md

+70-60
Original file line numberDiff line numberDiff line change
@@ -265,77 +265,84 @@ If you have branch specific configuration upgrading to v4 will force you to
265265
upgrade.
266266

267267
```yaml
268+
workflow: 'GitHubFlow/v1'
268269
branches:
269270
main:
270-
regex: ^master$|^main$
271-
mode: ContinuousDelivery
272271
label: ''
273272
increment: Patch
274-
prevent-increment-of-merged-branch-version: true
273+
prevent-increment:
274+
of-merged-branch: true
275275
track-merge-target: false
276-
source-branches: [ 'develop', 'release' ]
276+
track-merge-message: true
277+
regex: ^master$|^main$
278+
source-branches: []
279+
is-source-branch-for: []
277280
tracks-release-branches: false
278281
is-release-branch: false
279282
is-main-branch: true
280283
pre-release-weight: 55000
281-
develop:
282-
regex: ^dev(elop)?(ment)?$
283-
mode: ContinuousDeployment
284-
label: alpha
285-
increment: Minor
286-
prevent-increment-of-merged-branch-version: false
287-
track-merge-target: true
288-
source-branches: []
289-
tracks-release-branches: true
290-
is-release-branch: false
291-
is-main-branch: false
292-
pre-release-weight: 0
293284
release:
294-
regex: ^releases?[/-]
295-
mode: ContinuousDelivery
285+
mode: ManualDeployment
296286
label: beta
297-
increment: None
298-
prevent-increment-of-merged-branch-version: true
287+
increment: Patch
288+
prevent-increment:
289+
of-merged-branch: true
290+
when-branch-merged: false
291+
when-current-commit-tagged: false
299292
track-merge-target: false
300-
source-branches: [ 'develop', 'main', 'support', 'release' ]
293+
track-merge-message: true
294+
regex: ^releases?[\/-](?<BranchName>.+)
295+
source-branches:
296+
- main
297+
is-source-branch-for: []
301298
tracks-release-branches: false
302299
is-release-branch: true
303300
is-main-branch: false
304301
pre-release-weight: 30000
305302
feature:
306-
regex: ^features?[/-]
307-
mode: ContinuousDelivery
303+
mode: ManualDeployment
308304
label: '{BranchName}'
309305
increment: Inherit
310-
source-branches: [ 'develop', 'main', 'release', 'feature', 'support', 'hotfix' ]
306+
prevent-increment:
307+
when-current-commit-tagged: false
308+
track-merge-message: true
309+
regex: ^features?[\/-](?<BranchName>.+)
310+
source-branches:
311+
- main
312+
- release
313+
is-source-branch-for: []
314+
is-main-branch: false
311315
pre-release-weight: 30000
312316
pull-request:
313-
regex: ^(pull|pull\-requests|pr)[/-]
314317
mode: ContinuousDelivery
315-
label: PullRequest
318+
label: PullRequest{Number}
316319
increment: Inherit
317-
label-number-pattern: '[/-](?<number>\d+)[-/]'
318-
source-branches: [ 'develop', 'main', 'release', 'feature', 'support', 'hotfix' ]
320+
prevent-increment:
321+
of-merged-branch: true
322+
when-current-commit-tagged: false
323+
track-merge-message: true
324+
regex: ^(pull-requests|pull|pr)[\/-](?<Number>\d*)
325+
source-branches:
326+
- main
327+
- release
328+
- feature
329+
is-source-branch-for: []
319330
pre-release-weight: 30000
320-
hotfix:
321-
regex: ^hotfix(es)?[/-]
322-
mode: ContinuousDelivery
323-
label: beta
331+
unknown:
332+
mode: ManualDeployment
333+
label: '{BranchName}'
324334
increment: Inherit
325-
source-branches: [ 'release', 'main', 'support', 'hotfix' ]
326-
pre-release-weight: 30000
327-
support:
328-
regex: ^support[/-]
329-
mode: ContinuousDelivery
330-
label: ''
331-
increment: Patch
332-
prevent-increment-of-merged-branch-version: true
333-
track-merge-target: false
334-
source-branches: [ 'main' ]
335-
tracks-release-branches: false
336-
is-release-branch: false
337-
is-main-branch: true
338-
pre-release-weight: 55000
335+
prevent-increment:
336+
when-current-commit-tagged: false
337+
track-merge-message: false
338+
regex: (?<BranchName>.+)
339+
source-branches:
340+
- main
341+
- release
342+
- feature
343+
- pull-request
344+
is-source-branch-for: []
345+
is-main-branch: false
339346
```
340347

341348
If you don't specify the regex, the built-in for that branch config will be
@@ -441,9 +448,9 @@ The pre-release label to use for this branch. Use the value `{BranchName}` as a
441448
insert the value of the named group `BranchName` from the [regular expression](#regex).
442449

443450
For example: branch `feature/foo` would become a pre-release label
444-
of `alpha.foo` with `label: 'alpha.{BranchName}'` and `regex: '^features?[/-](?<BranchName>.+)'`.
451+
of `alpha.foo` with `label: 'alpha.{BranchName}'` and `regex: '^features?[\/-](?<BranchName>.+)'`.
445452

446-
Another example: branch `features/sc-12345/some-description` would become a pre-release label of `sc-12345` with `label: '{StoryNo}'` and `regex: '^features?[/-](?<StoryNo>sc-\d+)[-/].+'`.
453+
Another example: branch `features/sc-12345/some-description` would become a pre-release label of `sc-12345` with `label: '{StoryNo}'` and `regex: '^features?[\/-](?<StoryNo>sc-\d+)[-/].+'`.
447454

448455
**Note:** To clear a default use an empty string: `label: ''`
449456

@@ -475,25 +482,28 @@ This branch related property controls the behvior whether to use the tagged (val
475482
### label-number-pattern
476483

477484
Pull requests require us to extract the pre-release number out of the branch
478-
name so `refs/pulls/534/merge` builds as `PullRequest.534`. This is a regex with
479-
a named capture group called `number`.
480-
481-
If the branch `mode` is set to `ContinuousDeployment`, then the extracted
482-
`number` is appended to the name of the pre-release label and the number portion
483-
is the number of commits since the last label. This enables consecutive commits to
484-
the pull request branch to generate unique full semantic version numbers when
485-
the branch is configured to use ContinuousDeployment mode.
485+
name so `refs/pull/534/merge` builds as `PullRequest534`. This is a regex with
486+
a named capture group called `Number`.
486487

487488
**Example usage:**
488489

489490
```yaml
490491
branches:
491492
pull-request:
492-
mode: ContinuousDeployment
493-
label: PullRequest
493+
mode: ContinuousDelivery
494+
label: PullRequest{Number}
494495
increment: Inherit
495-
track-merge-target: true
496-
label-number-pattern: '[/-](?<number>\d+)[-/]'
496+
prevent-increment:
497+
of-merged-branch: true
498+
when-current-commit-tagged: false
499+
track-merge-message: true
500+
regex: ^(pull-requests|pull|pr)[\/-](?<Number>\d*)
501+
source-branches:
502+
- main
503+
- release
504+
- feature
505+
is-source-branch-for: []
506+
pre-release-weight: 30000
497507
```
498508

499509
### track-merge-target

0 commit comments

Comments
 (0)