Standardize docs

phatcher · asbjornu · commit 30ec70b273bb · 2025-09-12T10:26:20.000+02:00
Fix tests
diff --git a/docs/input/docs/reference/variables.md b/docs/input/docs/reference/variables.md
@@ -60,7 +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`.                                                               |
+|                   `CustomVersion` | The custom version, suitable for non-semantic 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 `-`.                                                                                                                     |
diff --git a/docs/input/docs/usage/cli/arguments.md b/docs/input/docs/usage/cli/arguments.md
@@ -113,42 +113,24 @@ Double quote character inside of the double quoted `value` has to be be escaped
 
 Following options are supported:
 
-1. `assembly-file-versioning-format`
 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`
-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. `custom-version-format`
-9. `label`
-10. `increment`
-11. `major-version-bump-message`
-12. `minor-version-bump-message`
-13. `mode`
-14. `next-version`
-15. `no-bump-message`
-16. `patch-version-bump-message`
-17. `tag-prefix`
-18. `tag-pre-release-weight`
-19. `update-build-number`
+2. `assembly-informational-format`
+3. `assembly-versioning-format`
+4. `assembly-versioning-scheme`
+5. `commit-date-format`
+6. `commit-message-incrementing`
+7. `custom-version-format`
+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`
 
 Read more about [Configuration](/docs/reference/configuration).
 
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/Approved/JsonVersionBuilderTests.Json.approved.txt b/src/GitVersion.Core.Tests/VersionCalculation/Approved/JsonVersionBuilderTests.Json.approved.txt
@@ -9,6 +9,7 @@
   "FullBuildMetaData": "5.Branch.feature1.Sha.commitSha",
   "FullSemVer": "1.2.0-unstable.4+5",
   "InformationalVersion": "1.2.0-unstable.4+5.Branch.feature1.Sha.commitSha",
+  "CustomVersion": "1.2.0-unstable.4",
   "Major": 1,
   "MajorMinorPatch": "1.2.0",
   "Minor": 2,
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeliveryModeForFeatureBranch.approved.txt b/src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeliveryModeForFeatureBranch.approved.txt
@@ -9,6 +9,7 @@
   "FullBuildMetaData": "5.Branch.feature-123.Sha.commitSha",
   "FullSemVer": "1.2.3+5",
   "InformationalVersion": "1.2.3+5.Branch.feature-123.Sha.commitSha",
+  "CustomVersion": "1.2.3",
   "Major": 1,
   "MajorMinorPatch": "1.2.3",
   "Minor": 2,
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeliveryModeForFeatureBranchWithCustomAssemblyInfoFormat.approved.txt b/src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeliveryModeForFeatureBranchWithCustomAssemblyInfoFormat.approved.txt
@@ -9,6 +9,7 @@
   "FullBuildMetaData": "5.Branch.feature-123.Sha.commitSha",
   "FullSemVer": "1.2.3+5",
   "InformationalVersion": "1.2.3+5.Branch.feature-123.Sha.commitShortSha",
+  "CustomVersion": "1.2.3",
   "Major": 1,
   "MajorMinorPatch": "1.2.3",
   "Minor": 2,
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeliveryModeForPreRelease.approved.txt b/src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeliveryModeForPreRelease.approved.txt
@@ -9,6 +9,7 @@
   "FullBuildMetaData": "5.Branch.develop.Sha.commitSha",
   "FullSemVer": "1.2.3-unstable.4+5",
   "InformationalVersion": "1.2.3-unstable.4+5.Branch.develop.Sha.commitSha",
+  "CustomVersion": "1.2.3-unstable.4",
   "Major": 1,
   "MajorMinorPatch": "1.2.3",
   "Minor": 2,
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeliveryModeForStable.approved.txt b/src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeliveryModeForStable.approved.txt
@@ -9,6 +9,7 @@
   "FullBuildMetaData": "5.Branch.develop.Sha.commitSha",
   "FullSemVer": "1.2.3+5",
   "InformationalVersion": "1.2.3+5.Branch.develop.Sha.commitSha",
+  "CustomVersion": "1.2.3",
   "Major": 1,
   "MajorMinorPatch": "1.2.3",
   "Minor": 2,
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeploymentModeForMainBranchWithEmptyLabel.approved.txt b/src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeploymentModeForMainBranchWithEmptyLabel.approved.txt
@@ -9,6 +9,7 @@
   "FullBuildMetaData": "Branch.main.Sha.commitSha",
   "FullSemVer": "1.2.3-9",
   "InformationalVersion": "1.2.3-9+Branch.main.Sha.commitSha",
+  "CustomVersion": "1.2.3-9",
   "Major": 1,
   "MajorMinorPatch": "1.2.3",
   "Minor": 2,
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeploymentModeForPreRelease.approved.txt b/src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeploymentModeForPreRelease.approved.txt
@@ -9,6 +9,7 @@
   "FullBuildMetaData": "Branch.develop.Sha.commitSha",
   "FullSemVer": "1.2.3-unstable.8",
   "InformationalVersion": "1.2.3-unstable.8+Branch.develop.Sha.commitSha",
+  "CustomVersion": "1.2.3-unstable.8",
   "Major": 1,
   "MajorMinorPatch": "1.2.3",
   "Minor": 2,
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeploymentModeForStable.approved.txt b/src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeploymentModeForStable.approved.txt
@@ -9,6 +9,7 @@
   "FullBuildMetaData": "Branch.develop.Sha.commitSha",
   "FullSemVer": "1.2.3-ci.5",
   "InformationalVersion": "1.2.3-ci.5+Branch.develop.Sha.commitSha",
+  "CustomVersion": "1.2.3-ci.5",
   "Major": 1,
   "MajorMinorPatch": "1.2.3",
   "Minor": 2,
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeploymentModeForStableWhenCurrentCommitIsTagged.approved.txt b/src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeploymentModeForStableWhenCurrentCommitIsTagged.approved.txt
@@ -9,6 +9,7 @@
   "FullBuildMetaData": "5.Sha.commitSha",
   "FullSemVer": "1.2.3+5",
   "InformationalVersion": "1.2.3+5.Sha.commitSha",
+  "CustomVersion": "1.2.3",
   "Major": 1,
   "MajorMinorPatch": "1.2.3",
   "Minor": 2,
diff --git a/src/GitVersion.MsBuild/PublicAPI.Unshipped.txt b/src/GitVersion.MsBuild/PublicAPI.Unshipped.txt
@@ -1 +1,3 @@
 #nullable enable
+GitVersion.MsBuild.Tasks.GetVersion.CustomVersion.get -> string!
+GitVersion.MsBuild.Tasks.GetVersion.CustomVersion.set -> void
diff --git a/src/GitVersion.MsBuild/Tasks/GetVersion.cs b/src/GitVersion.MsBuild/Tasks/GetVersion.cs
@@ -55,6 +55,9 @@ public class GetVersion : GitVersionTaskBase
     [Output]
     public string InformationalVersion { get; set; }
 
+    [Output]
+    public string CustomVersion { get; set; }
+
     [Output]
     public string BranchName { get; set; }
 
