Skip to content

Commit 4c6caee

Browse files
phatcherphatcher
committed
Standardize docs
Fix tests
1 parent 03a0238 commit 4c6caee

13 files changed

Lines changed: 32 additions & 36 deletions

‎docs/input/docs/reference/variables.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Each property of the above JSON document is described in the below table.
6060
| `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. |
6161
| `AssemblySemFileVer` | Suitable for .NET `AssemblyFileVersion`. Defaults to `Major.Minor.Patch.0`. |
6262
| `InformationalVersion` | Suitable for .NET `AssemblyInformationalVersion`. Defaults to `FullSemVer` suffixed by `FullBuildMetaData`. |
63-
| `CustomVersion` | The custom version, suitable for package managers with formatting changes, e.g. NuGet. Defaults to `SemVer`. |
63+
| `CustomVersion` | The custom version, suitable for non-semantic package managers with formatting changes, e.g. NuGet. Defaults to `SemVer`. |
6464
| `FullSemVer` | The full, SemVer 2.0 compliant version number. |
6565
| `BranchName` | The name of the checked out Git branch. |
6666
| `EscapedBranchName` | Equal to `BranchName`, but with `/` replaced with `-`. |

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

Lines changed: 17 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -113,42 +113,24 @@ 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`
117116
1. `assembly-file-versioning-scheme`
118-
1. `assembly-informational-format`
119-
1. `assembly-versioning-format`
120-
1. `assembly-versioning-scheme`
121-
1. `commit-date-format`
122-
1. `commit-message-incrementing`
123-
1. `custom-version-format`
124-
1. `label`
125-
1. `increment`
126-
1. `major-version-bump-message`
127-
1. `minor-version-bump-message`
128-
1. `mode`
129-
1. `next-version`
130-
1. `no-bump-message`
131-
1. `patch-version-bump-message`
132-
1. `tag-prefix`
133-
1. `tag-pre-release-weight`
134-
2. `assembly-file-versioning-scheme`
135-
3. `assembly-informational-format`
136-
4. `assembly-versioning-format`
137-
5. `assembly-versioning-scheme`
138-
6. `commit-date-format`
139-
7. `commit-message-incrementing`
140-
8. `custom-version-format`
141-
9. `label`
142-
10. `increment`
143-
11. `major-version-bump-message`
144-
12. `minor-version-bump-message`
145-
13. `mode`
146-
14. `next-version`
147-
15. `no-bump-message`
148-
16. `patch-version-bump-message`
149-
17. `tag-prefix`
150-
18. `tag-pre-release-weight`
151-
19. `update-build-number`
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`
123+
8. `label`
124+
9. `increment`
125+
10. `major-version-bump-message`
126+
11. `minor-version-bump-message`
127+
12. `mode`
128+
13. `next-version`
129+
14. `no-bump-message`
130+
15. `patch-version-bump-message`
131+
16. `tag-prefix`
132+
17. `tag-pre-release-weight`
133+
18. `update-build-number`
152134
153135
Read more about [Configuration](/docs/reference/configuration).
154136

‎src/GitVersion.Core.Tests/VersionCalculation/Approved/JsonVersionBuilderTests.Json.approved.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
"FullBuildMetaData": "5.Branch.feature1.Sha.commitSha",
1010
"FullSemVer": "1.2.0-unstable.4+5",
1111
"InformationalVersion": "1.2.0-unstable.4+5.Branch.feature1.Sha.commitSha",
12+
"CustomVersion": "1.2.0-unstable.4",
1213
"Major": 1,
1314
"MajorMinorPatch": "1.2.0",
1415
"Minor": 2,

‎src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeliveryModeForFeatureBranch.approved.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
"FullBuildMetaData": "5.Branch.feature-123.Sha.commitSha",
1010
"FullSemVer": "1.2.3+5",
1111
"InformationalVersion": "1.2.3+5.Branch.feature-123.Sha.commitSha",
12+
"CustomVersion": "1.2.3",
1213
"Major": 1,
1314
"MajorMinorPatch": "1.2.3",
1415
"Minor": 2,

‎src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeliveryModeForFeatureBranchWithCustomAssemblyInfoFormat.approved.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
"FullBuildMetaData": "5.Branch.feature-123.Sha.commitSha",
1010
"FullSemVer": "1.2.3+5",
1111
"InformationalVersion": "1.2.3+5.Branch.feature-123.Sha.commitShortSha",
12+
"CustomVersion": "1.2.3",
1213
"Major": 1,
1314
"MajorMinorPatch": "1.2.3",
1415
"Minor": 2,

‎src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeliveryModeForPreRelease.approved.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
"FullBuildMetaData": "5.Branch.develop.Sha.commitSha",
1010
"FullSemVer": "1.2.3-unstable.4+5",
1111
"InformationalVersion": "1.2.3-unstable.4+5.Branch.develop.Sha.commitSha",
12+
"CustomVersion": "1.2.3-unstable.4",
1213
"Major": 1,
1314
"MajorMinorPatch": "1.2.3",
1415
"Minor": 2,

‎src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeliveryModeForStable.approved.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
"FullBuildMetaData": "5.Branch.develop.Sha.commitSha",
1010
"FullSemVer": "1.2.3+5",
1111
"InformationalVersion": "1.2.3+5.Branch.develop.Sha.commitSha",
12+
"CustomVersion": "1.2.3",
1213
"Major": 1,
1314
"MajorMinorPatch": "1.2.3",
1415
"Minor": 2,

‎src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeploymentModeForMainBranchWithEmptyLabel.approved.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
"FullBuildMetaData": "Branch.main.Sha.commitSha",
1010
"FullSemVer": "1.2.3-9",
1111
"InformationalVersion": "1.2.3-9+Branch.main.Sha.commitSha",
12+
"CustomVersion": "1.2.3-9",
1213
"Major": 1,
1314
"MajorMinorPatch": "1.2.3",
1415
"Minor": 2,

‎src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeploymentModeForPreRelease.approved.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
"FullBuildMetaData": "Branch.develop.Sha.commitSha",
1010
"FullSemVer": "1.2.3-unstable.8",
1111
"InformationalVersion": "1.2.3-unstable.8+Branch.develop.Sha.commitSha",
12+
"CustomVersion": "1.2.3-unstable.8",
1213
"Major": 1,
1314
"MajorMinorPatch": "1.2.3",
1415
"Minor": 2,

‎src/GitVersion.Core.Tests/VersionCalculation/Approved/VariableProviderTests.ProvidesVariablesInContinuousDeploymentModeForStable.approved.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
"FullBuildMetaData": "Branch.develop.Sha.commitSha",
1010
"FullSemVer": "1.2.3-ci.5",
1111
"InformationalVersion": "1.2.3-ci.5+Branch.develop.Sha.commitSha",
12+
"CustomVersion": "1.2.3-ci.5",
1213
"Major": 1,
1314
"MajorMinorPatch": "1.2.3",
1415
"Minor": 2,

0 commit comments

Comments
 (0)