diff --git a/docs/input/docs/reference/configuration.md b/docs/input/docs/reference/configuration.md
index e185710262..ffa35f0aba 100644
--- a/docs/input/docs/reference/configuration.md
+++ b/docs/input/docs/reference/configuration.md
@@ -1,3 +1,10 @@
+
+
---
Order: 10
Title: Configuration
@@ -48,7 +55,9 @@ tag-prefix: '[abc]'
The built-in configuration for the `GitFlow` workflow (`workflow: GitFlow/v1`) looks like:
-```yaml
+
+
+```yml
assembly-versioning-scheme: MajorMinorPatch
assembly-file-versioning-scheme: MajorMinorPatch
tag-prefix: '[vV]?'
@@ -217,10 +226,14 @@ tracks-release-branches: false
is-release-branch: false
is-main-branch: false
```
+snippet source | anchor
+
The supported built-in configuration for the `GitHubFlow` workflow (`workflow: GitHubFlow/v1`) looks like:
-```yaml
+
+
+```yml
assembly-versioning-scheme: MajorMinorPatch
assembly-file-versioning-scheme: MajorMinorPatch
tag-prefix: '[vV]?'
@@ -280,12 +293,12 @@ branches:
increment: Inherit
prevent-increment:
when-current-commit-tagged: false
+ track-merge-message: true
regex: ^features?[/-](?.+)
source-branches:
- main
- release
is-source-branch-for: []
- track-merge-message: true
is-main-branch: false
pre-release-weight: 30000
pull-request:
@@ -296,13 +309,13 @@ branches:
of-merged-branch: true
when-current-commit-tagged: false
label-number-pattern: '[/-](?\d+)'
+ track-merge-message: true
regex: ^(pull|pull\-requests|pr)[/-]
source-branches:
- main
- release
- feature
is-source-branch-for: []
- track-merge-message: true
pre-release-weight: 30000
unknown:
mode: ManualDeployment
@@ -310,6 +323,7 @@ branches:
increment: Inherit
prevent-increment:
when-current-commit-tagged: false
+ track-merge-message: false
regex: (?.+)
source-branches:
- main
@@ -317,7 +331,6 @@ branches:
- feature
- pull-request
is-source-branch-for: []
- track-merge-message: false
is-main-branch: false
ignore:
sha: []
@@ -338,10 +351,14 @@ tracks-release-branches: false
is-release-branch: false
is-main-branch: false
```
+snippet source | anchor
+
The preview built-in configuration (experimental usage only) for the `TrunkBased` workflow (`workflow: TrunkBased/preview1`) looks like:
-```yaml
+
+
+```yml
assembly-versioning-scheme: MajorMinorPatch
assembly-file-versioning-scheme: MajorMinorPatch
tag-prefix: '[vV]?'
@@ -356,8 +373,8 @@ merge-message-formats: {}
update-build-number: true
semantic-version-format: Strict
strategies:
-- Mainline
- ConfiguredNextVersion
+- Mainline
branches:
main:
mode: ContinuousDeployment
@@ -365,46 +382,65 @@ branches:
increment: Patch
prevent-increment:
of-merged-branch: true
- when-current-commit-tagged: true
track-merge-target: false
+ track-merge-message: true
regex: ^master$|^main$
source-branches: []
+ is-source-branch-for: []
tracks-release-branches: false
is-release-branch: false
is-main-branch: true
pre-release-weight: 55000
feature:
+ mode: ContinuousDelivery
+ label: '{BranchName}'
increment: Minor
- regex: ^features?[/-](?.+)
prevent-increment:
when-current-commit-tagged: false
+ track-merge-message: true
+ regex: ^features?[/-](?.+)
source-branches:
- main
+ is-source-branch-for: []
+ is-main-branch: false
pre-release-weight: 30000
hotfix:
+ mode: ContinuousDelivery
+ label: '{BranchName}'
increment: Patch
- regex: ^hotfix(es)?[/-](?.+)
prevent-increment:
when-current-commit-tagged: false
+ regex: ^hotfix(es)?[/-](?.+)
source-branches:
- main
+ is-source-branch-for: []
+ is-release-branch: true
+ is-main-branch: false
pre-release-weight: 30000
pull-request:
mode: ContinuousDelivery
label: PullRequest
increment: Inherit
+ prevent-increment:
+ of-merged-branch: true
+ when-current-commit-tagged: false
label-number-pattern: '[/-](?\d+)'
+ track-merge-message: true
regex: ^(pull|pull\-requests|pr)[/-]
source-branches:
- main
+ - feature
+ - hotfix
+ is-source-branch-for: []
pre-release-weight: 30000
unknown:
increment: Patch
- regex: (?.+)
prevent-increment:
when-current-commit-tagged: false
+ regex: (?.+)
source-branches:
- main
+ is-source-branch-for: []
pre-release-weight: 30000
ignore:
sha: []
@@ -419,10 +455,14 @@ track-merge-target: false
track-merge-message: true
commit-message-incrementing: Enabled
regex: ''
+source-branches: []
+is-source-branch-for: []
tracks-release-branches: false
is-release-branch: false
is-main-branch: false
```
+snippet source | anchor
+
The details of the available options are as follows: