@@ -49,86 +49,86 @@ ignore:
49
49
50
50
The options are:
51
51
52
- ### ` next-version`
52
+ ### next-version
53
53
Allows you to bump the next version explicitly, useful for bumping ` master` or a
54
54
feature with breaking changes a major increment.
55
55
56
- # ## ` assembly-versioning-scheme`
56
+ # ## assembly-versioning-scheme
57
57
When updating assembly info, `assembly-versioning-scheme` tells GitVersion how
58
58
to treat the `AssemblyVersion` attribute. Useful to lock the major when using
59
59
Strong Naming. Note : you can use `None` to skip updating the `AssemblyVersion`
60
60
while still updating the `AssemblyFileVersion` and `AssemblyInformationVersion`
61
61
attributes.
62
62
63
- # ## ` assembly-informational-format`
63
+ # ## assembly-informational-format
64
64
Set this to any of the available [variables](/more-info/variables) to change the
65
65
value of the `AssemblyInformationalVersion` attribute. Default set to
66
66
` {InformationalVersion}` . It also supports string interpolation
67
67
(`{MajorMinorPatch}+{Branch}`)
68
68
69
- # ## ` mode`
69
+ # ## mode
70
70
Sets the `mode` of how GitVersion should create a new version. Read more at
71
71
[versioning mode](/reference/versioning-mode.md).
72
72
73
- # ## ` continuous-delivery-fallback-tag`
73
+ # ## continuous-delivery-fallback-tag
74
74
When using `mode : ContinuousDeployment`, the value specified in
75
75
` continuous-delivery-fallback-tag` will be used as the pre-release tag for
76
76
branches which do not have one specified. Default set to `ci`.
77
77
78
- # ## ` tag-prefix`
78
+ # ## tag-prefix
79
79
A regex which is used to trim git tags before processing (eg v1.0.0). Default is
80
80
` [vV]` though this is just for illustrative purposes as we do a IgnoreCase match
81
81
and could be `v`.
82
82
83
- # ## ` major-version-bump-message`
83
+ # ## major-version-bump-message
84
84
The regex to match commit messages with to perform a major version increment.
85
85
Default set to `'\+semver:\s?(breaking|major)'`, which will match occurrences of
86
86
`+semver : major` and `+semver: breaking` in a commit message.
87
87
88
- # ## ` minor-version-bump-message`
88
+ # ## minor-version-bump-message
89
89
The regex to match commit messages with to perform a minor version increment.
90
90
Default set to `'\+semver:\s?(feature|minor)'`, which will match occurrences of
91
91
`+semver : feature` and `+semver: minor` in a commit message.
92
92
93
- # ## ` patch-version-bump-message`
93
+ # ## patch-version-bump-message
94
94
The regex to match commit messages with to perform a patch version increment.
95
95
Default set to `'\+semver:\s?(fix|patch)'`, which will match occurrences of
96
96
`+semver : fix` and `+semver: patch` in a commit message.
97
97
98
- # ## ` no-bump-message`
98
+ # ## no-bump-message
99
99
Used to tell GitVersion not to increment when in Mainline development mode.
100
100
Default `\+semver:\s?(none|skip)`, which will match occurrences of `+semver :
101
101
none` and `+semver : skip`
102
102
103
- # ## ` legacy-semver-padding`
103
+ # ## legacy-semver-padding
104
104
The number of characters to pad `LegacySemVer` to in the `LegacySemVerPadded`
105
105
[variable](/more-info/variables). Is default set to `4`, which will pad the
106
106
` LegacySemVer` value of `3.0.0-beta1` to `3.0.0-beta0001`.
107
107
108
- # ## ` build-metadata-padding`
108
+ # ## build-metadata-padding
109
109
The number of characters to pad `BuildMetaData` to in the `BuildMetaDataPadded`
110
110
[variable](/more-info/variables). Is default set to `4`, which will pad the
111
111
` BuildMetaData` value of `1` to `0001`.
112
112
113
- # ## ` commits-since-version-source-padding`
113
+ # ## commits-since-version-source-padding
114
114
The number of characters to pad `CommitsSinceVersionSource` to in the
115
115
` CommitsSinceVersionSourcePadded` [variable](/more-info/variables). Is default
116
116
set to `4`, which will pad the `CommitsSinceVersionSource` value of `1` to
117
117
` 0001` .
118
118
119
- # ## ` commit-message-incrementing`
119
+ # ## commit-message-incrementing
120
120
Sets whether it should be possible to increment the version with special syntax
121
121
in the commit message. See the `*-version-bump-message` options above for
122
122
details on the syntax. Default set to `Enabled`; set to `Disabled` to disable.
123
123
124
- # ## ` ignore`
124
+ # ## ignore
125
125
The header for ignore configuration
126
126
127
- # ### ` sha`
127
+ # ### sha
128
128
A sequence of SHAs to be excluded from the version calculations. Useful when
129
129
there is a rogue commit in history yielding a bad version.
130
130
131
- # ### ` commits-before`
131
+ # ### commits-before
132
132
Date and time in the format `yyyy-MM-ddTHH:mm:ss` (eg `commits-before :
133
133
2015-10-23T12:23:15`) to setup an exclusion range. Effectively any commit before
134
134
` commits-before` will be ignored.
@@ -200,30 +200,30 @@ branches:
200
200
We don't envision many people needing to change most of these configuration
201
201
values, but here they are if you need to :
202
202
203
- # ## ` branches`
203
+ # ## branches
204
204
The header for all the individual branch configuration.
205
205
206
- # ## ` mode`
206
+ # ## mode
207
207
Same as for the global configuration, explained above.
208
208
209
- # ## ` tag`
209
+ # ## tag
210
210
The pre release tag to use for this branch. Use the value `useBranchName` to use
211
211
the branch name instead. For example `feature/foo` would become a pre-release
212
212
tag of `foo` with this value. Use the value `{BranchName}` as a placeholder to
213
213
insert the branch name. For example `feature/foo` would become a pre-release tag
214
214
of `alpha.foo` with the value of `alpha.{BranchName}`. **Note:** To clear a
215
215
default use an empty string : ` tag: ''`
216
216
217
- # ## ` increment`
217
+ # ## increment
218
218
The part of the SemVer to increment when GitVersion detects it needs to be (i.e
219
219
commit after a tag)
220
220
221
- # ## ` prevent-increment-of-merged-branch-version`
221
+ # ## prevent-increment-of-merged-branch-version
222
222
When `release-2.0.0` is merged into master, we want master to build `2.0.0`. If
223
223
` release-2.0.0` is merged into develop we want it to build `2.1.0`, this option
224
224
prevents incrementing after a versioned branch is merged
225
225
226
- # ## ` tag-number-pattern`
226
+ # ## tag-number-pattern
227
227
Pull requests require us to extract the pre-release number out of the branch
228
228
name so `refs/pulls/534/merge` builds as `PullRequest.534`. This is a regex with
229
229
a named capture group called `number`.
@@ -246,13 +246,13 @@ branches:
246
246
tag-name-pattern: '[/-](?<number>\d +)[-/]'
247
247
` ` `
248
248
249
- # ## ` track-merge-target`
249
+ # ## track-merge-target
250
250
Strategy which will look for tagged merge commits directly off the current
251
251
branch. For example `develop` → `release/1.0.0` → merge into `master` and tag
252
252
` 1.0.0` . The tag is *not* on develop, but develop should be version `1.0.0` now.
253
253
254
- # ## ` is-develop`
254
+ # ## is-develop
255
255
Indicates this branch config represents develop in GitFlow.
256
256
257
- # ## ` is-release-branch`
257
+ # ## is-release-branch
258
258
Indicates this branch config represents a release branch in GitFlow.
0 commit comments