Skip to content

Commit 0ff84a1

Browse files
committed
Clarify ignore config to resolve #2334
1 parent 52387f6 commit 0ff84a1

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

docs/input/docs/reference/configuration.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -216,11 +216,13 @@ Sets the format which will be used to format the `CommitDate` output variable.
216216

217217
### ignore
218218

219-
The header for ignore configuration.
219+
The header property for the `ignore` configuration.
220220

221-
### update-build-number
222-
223-
Configures GitVersion to update the build number or not when running on a build server.
221+
:::{.alert .alert-info}
222+
**Note:** When ignoring a commit or a range of commits, they are only ignored in
223+
the search for a [version source][version-sources], not when calculating other
224+
parts of the version number, such as build metadata.
225+
:::
224226

225227
#### sha
226228

@@ -248,6 +250,10 @@ Date and time in the format `yyyy-MM-ddTHH:mm:ss` (eg `commits-before:
248250
2015-10-23T12:23:15`) to setup an exclusion range. Effectively any commit before
249251
`commits-before` will be ignored.
250252

253+
### update-build-number
254+
255+
Configures GitVersion to update the build number or not when running on a build server.
256+
251257
### merge-message-formats
252258

253259
Custom merge message formats to enable identification of merge messages that do not
@@ -524,3 +530,5 @@ If the `pre-release-weight` is set, it would be added to the `PreReleaseNumber`
524530
to get a final `AssemblySemFileVer`, otherwise a branch specific default for
525531
`pre-release-weight` will be used in the calculation. Related Issues
526532
[1145](https://github.com/GitTools/GitVersion/issues/1145), [1366](https://github.com/GitTools/GitVersion/issues/1366)
533+
534+
[version-sources]: /docs/reference/version-sources

0 commit comments

Comments
 (0)