Skip to content

Commit

Permalink
Clarify ignore config to resolve #2334
Browse files Browse the repository at this point in the history
  • Loading branch information
asbjornu committed Feb 22, 2021
1 parent 52387f6 commit 0ff84a1
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions docs/input/docs/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,11 +216,13 @@ Sets the format which will be used to format the `CommitDate` output variable.

### ignore

The header for ignore configuration.
The header property for the `ignore` configuration.

### update-build-number

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

#### sha

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

### update-build-number

Configures GitVersion to update the build number or not when running on a build server.

### merge-message-formats

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

[version-sources]: /docs/reference/version-sources

0 comments on commit 0ff84a1

Please sign in to comment.