Introduce CustomVersion and custom-version-format

Author: Paul Hatcher

docs/input/docs/reference/configuration.md

@@ -519,6 +519,12 @@ Specifies the format of `AssemblyInformationalVersion`.
 Follows the same formatting semantics as `assembly-file-versioning-format`.
 The default value is `{InformationalVersion}`.
 
+### custom-version-format
+
+Specifies the format of `CustomVersion`.
+Follows the same formatting semantics as `assembly-file-versioning-format`.
+The default value is `{SemVer}`.
+
 ### mode
 
 Sets the `mode` of how GitVersion should create a new version. Read more at

docs/input/docs/reference/variables.md

@@ -27,6 +27,7 @@ what is available. For the `release/3.0.0` branch of GitVersion it shows:
     "AssemblySemVer": "3.22.11.0",
     "AssemblySemFileVer": "3.22.11.0",
     "InformationalVersion": "3.22.11-beta.99+88.Branch.release/3.022.011.Sha.28c853159a46b5a87e6cc9c4f6e940c59d6bc68a",
+    "CustomVersion": "3.22.11-beta.99",
     "FullSemVer": "3.22.11-beta.99+88",
     "BranchName": "release/3.022.011",
     "EscapedBranchName": "release-3.022.011",
@@ -59,6 +60,7 @@ Each property of the above JSON document is described in the below table.
 |                  `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. |
 |              `AssemblySemFileVer` | Suitable for .NET `AssemblyFileVersion`. Defaults to `Major.Minor.Patch.0`.                                                                                                |
 |            `InformationalVersion` | Suitable for .NET `AssemblyInformationalVersion`. Defaults to `FullSemVer` suffixed by `FullBuildMetaData`.                                                                |
+|                   `CustomVersion` | The custom version, suitable for package managers with formatting changes, e.g. NuGet. Defaults to `SemVer`.                                                               |
 |                      `FullSemVer` | The full, SemVer 2.0 compliant version number.                                                                                                                             |
 |                      `BranchName` | The name of the checked out Git branch.                                                                                                                                    |
 |               `EscapedBranchName` | Equal to `BranchName`, but with `/` replaced with `-`.                                                                                                                     |

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

@@ -114,23 +114,24 @@ Double quote character inside of the double quoted `value` has to be be escaped
 Following options are supported:
 
 1. `assembly-file-versioning-format`
-2. `assembly-file-versioning-scheme`
-3. `assembly-informational-format`
-4. `assembly-versioning-format`
-5. `assembly-versioning-scheme`
-6. `commit-date-format`
-7. `commit-message-incrementing`
-8. `label`
-9. `increment`
-10. `major-version-bump-message`
-11. `minor-version-bump-message`
-12. `mode`
-13. `next-version`
-14. `no-bump-message`
-15. `patch-version-bump-message`
-16. `tag-prefix`
-17. `tag-pre-release-weight`
-18. `update-build-number`
+1. `assembly-file-versioning-scheme`
+1. `assembly-informational-format`
+1. `assembly-versioning-format`
+1. `assembly-versioning-scheme`
+1. `commit-date-format`
+1. `commit-message-incrementing`
+1. `custom-version-format`
+1. `label`
+1. `increment`
+1. `major-version-bump-message`
+1. `minor-version-bump-message`
+1. `mode`
+1. `next-version`
+1. `no-bump-message`
+1. `patch-version-bump-message`
+1. `tag-prefix`
+1. `tag-pre-release-weight`
+1. `update-build-number`
 
 Read more about [Configuration](/docs/reference/configuration).