Skip to content

Commit 49ff7a3

Browse files
committed
Introduce CustomVersion and custom-version-format
1 parent b874c3f commit 49ff7a3

File tree

37 files changed

+727
-9
lines changed

37 files changed

+727
-9
lines changed

docs/input/docs/reference/configuration.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -519,6 +519,12 @@ Specifies the format of `AssemblyInformationalVersion`.
519519
Follows the same formatting semantics as `assembly-file-versioning-format`.
520520
The default value is `{InformationalVersion}`.
521521

522+
### custom-version-format
523+
524+
Specifies the format of `CustomVersion`.
525+
Follows the same formatting semantics as `assembly-file-versioning-format`.
526+
The default value is `{SemVer}`.
527+
522528
### mode
523529

524530
Sets the `mode` of how GitVersion should create a new version. Read more at

docs/input/docs/reference/mdsource/configuration.source.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,12 @@ Specifies the format of `AssemblyInformationalVersion`.
120120
Follows the same formatting semantics as `assembly-file-versioning-format`.
121121
The default value is `{InformationalVersion}`.
122122

123+
### custom-version-format
124+
125+
Specifies the format of `CustomVersion`.
126+
Follows the same formatting semantics as `assembly-file-versioning-format`.
127+
The default value is `{SemVer}`.
128+
123129
### mode
124130

125131
Sets the `mode` of how GitVersion should create a new version. Read more at

docs/input/docs/reference/variables.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ what is available. For the `release/3.0.0` branch of GitVersion it shows:
2727
"AssemblySemVer": "3.22.11.0",
2828
"AssemblySemFileVer": "3.22.11.0",
2929
"InformationalVersion": "3.22.11-beta.99+88.Branch.release/3.022.011.Sha.28c853159a46b5a87e6cc9c4f6e940c59d6bc68a",
30+
"CustomVersion": "3.22.11-beta.99",
3031
"FullSemVer": "3.22.11-beta.99+88",
3132
"BranchName": "release/3.022.011",
3233
"EscapedBranchName": "release-3.022.011",
@@ -59,6 +60,7 @@ Each property of the above JSON document is described in the below table.
5960
| `AssemblySemVer` | Suitable for .NET `AssemblyVersion`. Defaults to `Major.Minor.0.0` to allow the assembly to be hotfixed without breaking existing applications that may be referencing it. |
6061
| `AssemblySemFileVer` | Suitable for .NET `AssemblyFileVersion`. Defaults to `Major.Minor.Patch.0`. |
6162
| `InformationalVersion` | Suitable for .NET `AssemblyInformationalVersion`. Defaults to `FullSemVer` suffixed by `FullBuildMetaData`. |
63+
| `CustomVersion` | The custom version, suitable for non-semantic package managers with formatting changes, e.g. NuGet. Defaults to `SemVer`. |
6264
| `FullSemVer` | The full, SemVer 2.0 compliant version number. |
6365
| `BranchName` | The name of the checked out Git branch. |
6466
| `EscapedBranchName` | Equal to `BranchName`, but with `/` replaced with `-`. |

docs/input/docs/usage/cli/arguments.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -113,13 +113,13 @@ Double quote character inside of the double quoted `value` has to be be escaped
113113
114114
Following options are supported:
115115
116-
1. `assembly-file-versioning-format`
117-
2. `assembly-file-versioning-scheme`
118-
3. `assembly-informational-format`
119-
4. `assembly-versioning-format`
120-
5. `assembly-versioning-scheme`
121-
6. `commit-date-format`
122-
7. `commit-message-incrementing`
116+
1. `assembly-file-versioning-scheme`
117+
2. `assembly-informational-format`
118+
3. `assembly-versioning-format`
119+
4. `assembly-versioning-scheme`
120+
5. `commit-date-format`
121+
6. `commit-message-incrementing`
122+
7. `custom-version-format`
123123
8. `label`
124124
9. `increment`
125125
10. `major-version-bump-message`

0 commit comments

Comments
 (0)