Changed the Continuous Deployment output to be more sensible

Author: JakeGinnivan

GitVersionCore.Tests/VariableProviderTests.ProvidesVariablesInContinuousDeliveryMode.approved.txt renamed to GitVersionCore.Tests/VariableProviderTests.ProvidesVariablesInContinuousDeliveryModeForPreRelease.approved.txt

@@ -0,0 +1,20 @@
+{
+  "Major":1,
+  "Minor":2,
+  "Patch":3,
+  "PreReleaseTag":"",
+  "PreReleaseTagWithDash":"",
+  "BuildMetaData":5,
+  "FullBuildMetaData":"5.Branch.develop.Sha.commitSha",
+  "MajorMinorPatch":"1.2.3",
+  "SemVer":"1.2.3",
+  "LegacySemVer":"1.2.3",
+  "LegacySemVerPadded":"1.2.3",
+  "AssemblySemVer":"1.2.3.0",
+  "FullSemVer":"1.2.3+5",
+  "InformationalVersion":"1.2.3+5.Branch.develop.Sha.commitSha",
+  "BranchName":"develop",
+  "Sha":"commitSha",
+  "NuGetVersionV2":"1.2.3",
+  "NuGetVersion":"1.2.3"
+}

GitVersionCore.Tests/VariableProviderTests.ProvidesVariablesInContinuousDeliveryModeForStable.approved.txt

@@ -0,0 +1,20 @@
+{
+  "Major":1,
+  "Minor":2,
+  "Patch":3,
+  "PreReleaseTag":"unstable.5",
+  "PreReleaseTagWithDash":"-unstable.5",
+  "BuildMetaData":5,
+  "FullBuildMetaData":"5.Branch.develop.Sha.commitSha",
+  "MajorMinorPatch":"1.2.3",
+  "SemVer":"1.2.3-unstable.5",
+  "LegacySemVer":"1.2.3-unstable5",
+  "LegacySemVerPadded":"1.2.3-unstable0005",
+  "AssemblySemVer":"1.2.3.0",
+  "FullSemVer":"1.2.3-unstable.5+4",
+  "InformationalVersion":"1.2.3-unstable.5+4.Branch.develop.Sha.commitSha",
+  "BranchName":"develop",
+  "Sha":"commitSha",
+  "NuGetVersionV2":"1.2.3-unstable0005",
+  "NuGetVersion":"1.2.3-unstable0005"
+}

GitVersionCore.Tests/VariableProviderTests.ProvidesVariablesInContinuousDeploymentMode.approved.txt

@@ -0,0 +1,20 @@
+{
+  "Major":1,
+  "Minor":2,
+  "Patch":3,
+  "PreReleaseTag":"",
+  "PreReleaseTagWithDash":"",
+  "BuildMetaData":5,
+  "FullBuildMetaData":"5.Branch.develop.Sha.commitSha",
+  "MajorMinorPatch":"1.2.3",
+  "SemVer":"1.2.3.5",
+  "LegacySemVer":"1.2.3.5",
+  "LegacySemVerPadded":"1.2.3.5",
+  "AssemblySemVer":"1.2.3.0",
+  "FullSemVer":"1.2.3.5",
+  "InformationalVersion":"1.2.3.5",
+  "BranchName":"develop",
+  "Sha":"commitSha",
+  "NuGetVersionV2":"1.2.3.5",
+  "NuGetVersion":"1.2.3.5"
+}

GitVersionCore.Tests/VariableProviderTests.ProvidesVariablesInContinuousDeploymentModeForPreRelease.approved.txt

@@ -7,7 +7,7 @@
 public class VariableProviderTests
 {
     [Test]
-    public void ProvidesVariablesInContinuousDeliveryMode()
+    public void ProvidesVariablesInContinuousDeliveryModeForPreRelease()
     {
         var semVer = new SemanticVersion
         {
@@ -27,7 +27,7 @@ public void ProvidesVariablesInContinuousDeliveryMode()
     }
 
     [Test]
-    public void ProvidesVariablesInContinuousDeploymentMode()
+    public void ProvidesVariablesInContinuousDeploymentModeForPreRelease()
     {
         var semVer = new SemanticVersion
         {
@@ -45,4 +45,42 @@ public void ProvidesVariablesInContinuousDeploymentMode()
 
         Approvals.Verify(JsonOutputFormatter.ToJson(vars));
     }
+
+    [Test]
+    public void ProvidesVariablesInContinuousDeliveryModeForStable()
+    {
+        var semVer = new SemanticVersion
+        {
+            Major = 1,
+            Minor = 2,
+            Patch = 3,
+            BuildMetaData = "5.Branch.develop"
+        };
+
+        semVer.BuildMetaData.Sha = "commitSha";
+        semVer.BuildMetaData.CommitDate = DateTimeOffset.Parse("2014-03-06 23:59:59Z");
+
+        var vars = VariableProvider.GetVariablesFor(semVer, AssemblyVersioningScheme.MajorMinorPatch, VersioningMode.ContinuousDelivery);
+
+        Approvals.Verify(JsonOutputFormatter.ToJson(vars));
+    }
+
+    [Test]
+    public void ProvidesVariablesInContinuousDeploymentModeForStable()
+    {
+        var semVer = new SemanticVersion
+        {
+            Major = 1,
+            Minor = 2,
+            Patch = 3,
+            BuildMetaData = "5.Branch.develop"
+        };
+
+        semVer.BuildMetaData.Sha = "commitSha";
+        semVer.BuildMetaData.CommitDate = DateTimeOffset.Parse("2014-03-06 23:59:59Z");
+
+        var vars = VariableProvider.GetVariablesFor(semVer, AssemblyVersioningScheme.MajorMinorPatch, VersioningMode.ContinuousDeployment);
+
+        Approvals.Verify(JsonOutputFormatter.ToJson(vars));
+    }
 }

GitVersionCore.Tests/VariableProviderTests.ProvidesVariablesInContinuousDeploymentModeForStable.approved.txt

@@ -84,6 +84,7 @@
     <Compile Include="Helpers\IFileSystem.cs" />
     <Compile Include="Helpers\ProcessHelper.cs" />
     <Compile Include="LastMinorVersionFinder.cs" />
+    <Compile Include="OutputVariables\CommitsAsFourthVersionPartFormatter.cs" />
     <Compile Include="OutputVariables\VersionVariables.cs" />
     <Compile Include="SemanticVersionExtensions.cs" />
     <Compile Include="VersioningModes\ContinuousDeliveryMode.cs" />
@@ -124,7 +125,6 @@
     <Compile Include="OutputFormatters\BuildOutputFormatter.cs" />
     <Compile Include="OutputFormatters\JsonOutputFormatter.cs" />
     <Compile Include="OutputType.cs" />
-    <Compile Include="OutputVariables\CiFeedFormatter.cs" />
     <Compile Include="OutputVariables\VariableProvider.cs" />
     <Compile Include="AssemblyInfo.cs" />
     <Compile Include="RepositoryLoader.cs" />

GitVersionCore.Tests/VariableProviderTests.cs

@@ -0,0 +1,30 @@
+namespace GitVersion
+{
+    using System;
+
+    public class CommitsAsFourthVersionPartFormatter : IFormatProvider, ICustomFormatter
+    {
+        public object GetFormat(Type formatType)
+        {
+            if (formatType == typeof(SemanticVersion))
+                return this;
+
+            return null;
+        }
+
+        public string Format(string format, object arg, IFormatProvider formatProvider)
+        {
+            var semanticVersion = (SemanticVersion)arg;
+            var metaData = new SemanticVersionBuildMetaData(semanticVersion.BuildMetaData)
+            {
+                CommitsSinceTag = null
+            }.ToString();
+
+            return string.Format("{0}.{1}{2}{3}",
+                semanticVersion.ToString("j"),
+                semanticVersion.BuildMetaData.CommitsSinceTag,
+                semanticVersion.PreReleaseTag.HasTag() ? "-" + semanticVersion.PreReleaseTag.ToString(format) : string.Empty,
+                !string.IsNullOrEmpty(metaData) ? "+" + metaData : string.Empty);
+        }
+    }
+}

GitVersionCore/GitVersionCore.csproj

@@ -1,11 +1,29 @@
 namespace GitVersion
 {
+    using System;
+
     public static class VariableProvider
     {
         public static VersionVariables GetVariablesFor(SemanticVersion semanticVersion, AssemblyVersioningScheme assemblyVersioningScheme, VersioningMode mode)
         {
             var bmd = semanticVersion.BuildMetaData;
-            var formatter = mode == VersioningMode.ContinuousDeployment ? new CiFeedFormatter() : null;
+            IFormatProvider formatProvider = null;
+            if (mode == VersioningMode.ContinuousDeployment)
+            {
+                // For continuous deployment the commits since tag gets promoted to the pre-release number
+                semanticVersion = new SemanticVersion(semanticVersion);
+                if (semanticVersion.PreReleaseTag.HasTag())
+                {
+                    var oldPreReleaseNumber = semanticVersion.PreReleaseTag.Number;
+                    semanticVersion.PreReleaseTag.Number = semanticVersion.BuildMetaData.CommitsSinceTag;
+                    semanticVersion.BuildMetaData.CommitsSinceTag = oldPreReleaseNumber;
+                }
+                else
+                {
+                    // When there is no pre-release tag we will make the version a 4 part number
+                    formatProvider = new CommitsAsFourthVersionPartFormatter();
+                }
+            }
 
             var variables = new VersionVariables(
                 major: semanticVersion.Major.ToString(),
@@ -16,12 +34,12 @@ public static VersionVariables GetVariablesFor(SemanticVersion semanticVersion,
                 buildMetaData: bmd,
                 fullBuildMetaData: bmd.ToString("f"),
                 majorMinorPatch: string.Format("{0}.{1}.{2}", semanticVersion.Major, semanticVersion.Minor, semanticVersion.Patch),
-                semVer: semanticVersion.ToString(null, formatter),
-                legacySemVer: semanticVersion.ToString("l", formatter),
-                legacySemVerPadded: semanticVersion.ToString("lp", formatter),
+                semVer: semanticVersion.ToString(null, formatProvider),
+                legacySemVer: semanticVersion.ToString("l", formatProvider),
+                legacySemVerPadded: semanticVersion.ToString("lp", formatProvider),
                 assemblySemVer: semanticVersion.GetAssemblyVersion(assemblyVersioningScheme),
-                fullSemVer: semanticVersion.ToString("f", formatter),
-                informationalVersion: semanticVersion.ToString("i", formatter),
+                fullSemVer: semanticVersion.ToString("f", formatProvider),
+                informationalVersion: semanticVersion.ToString("i", formatProvider),
                 branchName: bmd.Branch,
                 sha: bmd.Sha);
 

GitVersionCore/OutputVariables/CiFeedFormatter.cs

@@ -21,6 +21,16 @@ public SemanticVersion()
             BuildMetaData = new SemanticVersionBuildMetaData();
         }
 
+        public SemanticVersion(SemanticVersion semanticVersion)
+        {
+            Major = semanticVersion.Major;
+            Minor = semanticVersion.Minor;
+            Patch = semanticVersion.Patch;
+
+            PreReleaseTag = new SemanticVersionPreReleaseTag(semanticVersion.PreReleaseTag);
+            BuildMetaData = new SemanticVersionBuildMetaData(semanticVersion.BuildMetaData);
+        }
+
         public bool Equals(SemanticVersion obj)
         {
             if (obj == null)

GitVersionCore/OutputVariables/CommitsAsFourthVersionPartFormatter.cs

@@ -22,14 +22,23 @@ public SemanticVersionBuildMetaData()
         {
         }
 
-        public SemanticVersionBuildMetaData(int? commitsSinceTag, string branch, string commitSha,DateTimeOffset commitDate)
+        public SemanticVersionBuildMetaData(int? commitsSinceTag, string branch, string commitSha, DateTimeOffset commitDate, string otherMetadata = null)
         {
             Sha = commitSha;
             CommitsSinceTag = commitsSinceTag;
             Branch = branch;
             CommitDate = commitDate;
+            OtherMetaData = otherMetadata;
         }
 
+        public SemanticVersionBuildMetaData(SemanticVersionBuildMetaData buildMetaData)
+        {
+            Sha = buildMetaData.Sha;
+            CommitsSinceTag = buildMetaData.CommitsSinceTag;
+            Branch = buildMetaData.Branch;
+            CommitDate = buildMetaData.CommitDate;
+            OtherMetaData = buildMetaData.OtherMetaData;
+        }
 
         public override bool Equals(object obj)
         {

GitVersionCore/OutputVariables/VariableProvider.cs

@@ -18,6 +18,13 @@ public SemanticVersionPreReleaseTag(string name, int? number)
             Name = name;
             Number = number;
         }
+
+        public SemanticVersionPreReleaseTag(SemanticVersionPreReleaseTag preReleaseTag)
+        {
+            Name = preReleaseTag.Name;
+            Number = preReleaseTag.Number;
+        }
+
         public string Name { get; set; }
         public int? Number { get; set; }