Skip to content

Commit c400025

Browse files
committed
Fixup
1 parent 16997a6 commit c400025

File tree

2 files changed

+27
-27
lines changed

2 files changed

+27
-27
lines changed

docs/configuration.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -49,86 +49,86 @@ ignore:
4949
5050
The options are:
5151
52-
### `next-version`
52+
### next-version
5353
Allows you to bump the next version explicitly, useful for bumping `master` or a
5454
feature with breaking changes a major increment.
5555

56-
### `assembly-versioning-scheme`
56+
### assembly-versioning-scheme
5757
When updating assembly info, `assembly-versioning-scheme` tells GitVersion how
5858
to treat the `AssemblyVersion` attribute. Useful to lock the major when using
5959
Strong Naming. Note: you can use `None` to skip updating the `AssemblyVersion`
6060
while still updating the `AssemblyFileVersion` and `AssemblyInformationVersion`
6161
attributes.
6262

63-
### `assembly-informational-format`
63+
### assembly-informational-format
6464
Set this to any of the available [variables](/more-info/variables) to change the
6565
value of the `AssemblyInformationalVersion` attribute. Default set to
6666
`{InformationalVersion}`. It also supports string interpolation
6767
(`{MajorMinorPatch}+{Branch}`)
6868

69-
### `mode`
69+
### mode
7070
Sets the `mode` of how GitVersion should create a new version. Read more at
7171
[versioning mode](/reference/versioning-mode.md).
7272

73-
### `continuous-delivery-fallback-tag`
73+
### continuous-delivery-fallback-tag
7474
When using `mode: ContinuousDeployment`, the value specified in
7575
`continuous-delivery-fallback-tag` will be used as the pre-release tag for
7676
branches which do not have one specified. Default set to `ci`.
7777

78-
### `tag-prefix`
78+
### tag-prefix
7979
A regex which is used to trim git tags before processing (eg v1.0.0). Default is
8080
`[vV]` though this is just for illustrative purposes as we do a IgnoreCase match
8181
and could be `v`.
8282

83-
### `major-version-bump-message`
83+
### major-version-bump-message
8484
The regex to match commit messages with to perform a major version increment.
8585
Default set to `'\+semver:\s?(breaking|major)'`, which will match occurrences of
8686
`+semver: major` and `+semver: breaking` in a commit message.
8787

88-
### `minor-version-bump-message`
88+
### minor-version-bump-message
8989
The regex to match commit messages with to perform a minor version increment.
9090
Default set to `'\+semver:\s?(feature|minor)'`, which will match occurrences of
9191
`+semver: feature` and `+semver: minor` in a commit message.
9292

93-
### `patch-version-bump-message`
93+
### patch-version-bump-message
9494
The regex to match commit messages with to perform a patch version increment.
9595
Default set to `'\+semver:\s?(fix|patch)'`, which will match occurrences of
9696
`+semver: fix` and `+semver: patch` in a commit message.
9797

98-
### `no-bump-message`
98+
### no-bump-message
9999
Used to tell GitVersion not to increment when in Mainline development mode.
100100
Default `\+semver:\s?(none|skip)`, which will match occurrences of `+semver:
101101
none` and `+semver: skip`
102102

103-
### `legacy-semver-padding`
103+
### legacy-semver-padding
104104
The number of characters to pad `LegacySemVer` to in the `LegacySemVerPadded`
105105
[variable](/more-info/variables). Is default set to `4`, which will pad the
106106
`LegacySemVer` value of `3.0.0-beta1` to `3.0.0-beta0001`.
107107

108-
### `build-metadata-padding`
108+
### build-metadata-padding
109109
The number of characters to pad `BuildMetaData` to in the `BuildMetaDataPadded`
110110
[variable](/more-info/variables). Is default set to `4`, which will pad the
111111
`BuildMetaData` value of `1` to `0001`.
112112

113-
### `commits-since-version-source-padding`
113+
### commits-since-version-source-padding
114114
The number of characters to pad `CommitsSinceVersionSource` to in the
115115
`CommitsSinceVersionSourcePadded` [variable](/more-info/variables). Is default
116116
set to `4`, which will pad the `CommitsSinceVersionSource` value of `1` to
117117
`0001`.
118118

119-
### `commit-message-incrementing`
119+
### commit-message-incrementing
120120
Sets whether it should be possible to increment the version with special syntax
121121
in the commit message. See the `*-version-bump-message` options above for
122122
details on the syntax. Default set to `Enabled`; set to `Disabled` to disable.
123123

124-
### `ignore`
124+
### ignore
125125
The header for ignore configuration
126126

127-
#### `sha`
127+
#### sha
128128
A sequence of SHAs to be excluded from the version calculations. Useful when
129129
there is a rogue commit in history yielding a bad version.
130130

131-
#### `commits-before`
131+
#### commits-before
132132
Date and time in the format `yyyy-MM-ddTHH:mm:ss` (eg `commits-before:
133133
2015-10-23T12:23:15`) to setup an exclusion range. Effectively any commit before
134134
`commits-before` will be ignored.
@@ -200,30 +200,30 @@ branches:
200200
We don't envision many people needing to change most of these configuration
201201
values, but here they are if you need to:
202202

203-
### `branches`
203+
### branches
204204
The header for all the individual branch configuration.
205205

206-
### `mode`
206+
### mode
207207
Same as for the global configuration, explained above.
208208

209-
### `tag`
209+
### tag
210210
The pre release tag to use for this branch. Use the value `useBranchName` to use
211211
the branch name instead. For example `feature/foo` would become a pre-release
212212
tag of `foo` with this value. Use the value `{BranchName}` as a placeholder to
213213
insert the branch name. For example `feature/foo` would become a pre-release tag
214214
of `alpha.foo` with the value of `alpha.{BranchName}`. **Note:** To clear a
215215
default use an empty string: `tag: ''`
216216

217-
### `increment`
217+
### increment
218218
The part of the SemVer to increment when GitVersion detects it needs to be (i.e
219219
commit after a tag)
220220

221-
### `prevent-increment-of-merged-branch-version`
221+
### prevent-increment-of-merged-branch-version
222222
When `release-2.0.0` is merged into master, we want master to build `2.0.0`. If
223223
`release-2.0.0` is merged into develop we want it to build `2.1.0`, this option
224224
prevents incrementing after a versioned branch is merged
225225

226-
### `tag-number-pattern`
226+
### tag-number-pattern
227227
Pull requests require us to extract the pre-release number out of the branch
228228
name so `refs/pulls/534/merge` builds as `PullRequest.534`. This is a regex with
229229
a named capture group called `number`.
@@ -246,13 +246,13 @@ branches:
246246
tag-name-pattern: '[/-](?<number>\d+)[-/]'
247247
```
248248

249-
### `track-merge-target`
249+
### track-merge-target
250250
Strategy which will look for tagged merge commits directly off the current
251251
branch. For example `develop` → `release/1.0.0` → merge into `master` and tag
252252
`1.0.0`. The tag is *not* on develop, but develop should be version `1.0.0` now.
253253

254-
### `is-develop`
254+
### is-develop
255255
Indicates this branch config represents develop in GitFlow.
256256

257-
### `is-release-branch`
257+
### is-release-branch
258258
Indicates this branch config represents a release branch in GitFlow.

src/GitVersionCore.Tests/DocumentationTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public void ConfigurationDocumentationIsUpToDate()
3232

3333
foreach (var configProperty in configProperties)
3434
{
35-
var formattedConfigProperty = string.Format("### `{0}`", configProperty);
35+
var formattedConfigProperty = string.Format("### {0}", configProperty);
3636
configurationDocumentationFile.ShouldContain(formattedConfigProperty,
3737
Environment.NewLine + configurationDocumentationFile);
3838
}

0 commit comments

Comments
 (0)