Added additional variables for NuGet (see #201)

Author: GeertvanHorrik

GitVersionCore/OutputVariables/VariableProvider.cs

@@ -27,6 +27,12 @@ public static class VariableProvider
         public const string AssemblyFileVersion = "AssemblyFileVersion";
         public const string OriginalRelease = "OriginalRelease";
 
+        // Synonyms
+        public const string Version = "Version";
+        public const string NuGetVersionV2 = "NuGetVersionV2";
+        public const string NuGetVersionV3 = "NuGetVersionV3";
+        public const string NuGetVersion = "NuGetVersion";
+
         public static Dictionary<string, string> GetVariablesFor(
             SemanticVersion semanticVersion,
             AssemblyVersioningScheme assemblyVersioningScheme = AssemblyVersioningScheme.MajorMinorPatch,
@@ -67,6 +73,14 @@ public static Dictionary<string, string> GetVariablesFor(
                     bmd.ReleaseDate.OriginalDate.UtcDateTime.ToString("u"))},
             };
 
+            // Synonyms to ensure backwards compatibility
+            variables[Version] = variables[LegacySemVer];
+
+            // Use ToLower() to fix a bug where Beta and beta are different in NuGet
+            variables[NuGetVersionV2] = variables[LegacySemVerPadded].ToLower();
+            //variables[NuGetVersionV3] = variables[LegacySemVerPadded].ToLower(); // TODO: when v3 is released, determine what to use
+            variables[NuGetVersion] = variables[NuGetVersionV2];
+
             return variables;
         }
     }

GitVersionTask/GetVersion.cs

@@ -74,6 +74,15 @@ public class GetVersion : Task
         [Output]
         public string OriginalRelease { get; set; }
 
+        [Output]
+        public string Version { get; set; }
+
+        [Output]
+        public string NuGetVersionV2 { get; set; }
+
+        [Output]
+        public string NuGetVersion { get; set; }
+
         TaskLogger logger;
 
         public GetVersion()

Tests/AssemblyInfoBuilderTests.VerifyAssemblyVersion_Major.approved.txt

@@ -44,6 +44,9 @@ static class GitVersionInformation
     public static string AssemblyVersion = "2.0.0.0";
     public static string AssemblyFileVersion = "2.3.4.0";
     public static string OriginalRelease = "originalCommitSha.2014-03-01 00:00:01Z";
+    public static string Version = "2.3.4";
+    public static string NuGetVersionV2 = "2.3.4";
+    public static string NuGetVersion = "2.3.4";
 
 }
 

Tests/AssemblyInfoBuilderTests.VerifyAssemblyVersion_MajorMinor.approved.txt

@@ -44,6 +44,9 @@ static class GitVersionInformation
     public static string AssemblyVersion = "2.3.0.0";
     public static string AssemblyFileVersion = "2.3.4.0";
     public static string OriginalRelease = "originalCommitSha.2014-03-01 00:00:01Z";
+    public static string Version = "2.3.4";
+    public static string NuGetVersionV2 = "2.3.4";
+    public static string NuGetVersion = "2.3.4";
 
 }
 

Tests/AssemblyInfoBuilderTests.VerifyAssemblyVersion_MajorMinorPatch.approved.txt

@@ -44,6 +44,9 @@ static class GitVersionInformation
     public static string AssemblyVersion = "2.3.4.0";
     public static string AssemblyFileVersion = "2.3.4.0";
     public static string OriginalRelease = "originalCommitSha.2014-03-01 00:00:01Z";
+    public static string Version = "2.3.4";
+    public static string NuGetVersionV2 = "2.3.4";
+    public static string NuGetVersion = "2.3.4";
 
 }
 

Tests/AssemblyInfoBuilderTests.VerifyAssemblyVersion_None.approved.txt

@@ -44,6 +44,9 @@ static class GitVersionInformation
     public static string AssemblyVersion = "1.0.0.0";
     public static string AssemblyFileVersion = "2.3.4.0";
     public static string OriginalRelease = "originalCommitSha.2014-03-01 00:00:01Z";
+    public static string Version = "2.3.4";
+    public static string NuGetVersionV2 = "2.3.4";
+    public static string NuGetVersion = "2.3.4";
 
 }
 

Tests/AssemblyInfoBuilderTests.VerifyCreatedCode.approved.txt

@@ -44,6 +44,9 @@ static class GitVersionInformation
     public static string AssemblyVersion = "1.2.3.0";
     public static string AssemblyFileVersion = "1.2.3.0";
     public static string OriginalRelease = "originalCommitSha.2014-03-01 00:00:01Z";
+    public static string Version = "1.2.3-unstable4";
+    public static string NuGetVersionV2 = "1.2.3-unstable0004";
+    public static string NuGetVersion = "1.2.3-unstable0004";
 
 }
 

Tests/JsonVersionBuilderTests.Json.approved.txt

@@ -19,5 +19,8 @@
   "Sha":"commitSha",
   "AssemblyVersion":"1.2.3.0",
   "AssemblyFileVersion":"1.2.3.0",
-  "OriginalRelease":"originalCommitSha.2014-03-01 00:00:01Z"
+  "OriginalRelease":"originalCommitSha.2014-03-01 00:00:01Z",
+  "Version":"1.2.3-unstable4",
+  "NuGetVersionV2":"1.2.3-unstable0004",
+  "NuGetVersion":"1.2.3-unstable0004"
 }

Tests/Tests.csproj

@@ -142,6 +142,7 @@
   </ItemGroup>
   <ItemGroup>
     <Content Include="AssemblyInfoBuilderTests.VerifyAssemblyVersion_Major.approved.txt" />
+    <Content Include="AssemblyInfoBuilderTests.VerifyAssemblyVersion_MajorMinor.approved.txt" />
     <Content Include="AssemblyInfoBuilderTests.VerifyAssemblyVersion_MajorMinorPatch.approved.txt" />
     <Content Include="AssemblyInfoBuilderTests.VerifyAssemblyVersion_None.approved.txt" />
     <Content Include="AssemblyInfoBuilderTests.VerifyCreatedCode.approved.txt" />

Tests/VariableProviderTests.cs

@@ -72,5 +72,9 @@ public void AssemblyVersion(
 
         vars[VariableProvider.AssemblyVersion].ShouldBe(version);
         vars[VariableProvider.AssemblyFileVersion].ShouldBe(fileVersion);
+
+        vars[VariableProvider.Version].ShouldBe(vars[VariableProvider.LegacySemVer]);
+        vars[VariableProvider.NuGetVersionV2].ShouldBe(vars[VariableProvider.LegacySemVerPadded].ToLower());
+        vars[VariableProvider.NuGetVersion].ShouldBe(vars[VariableProvider.NuGetVersionV2]);
     }
 }