Merge pull request #701 from onovotny/build-meta

Add property to always expose commits since last version

Author: JakeGinnivan

docs/more-info/variables.md

@@ -22,7 +22,10 @@ For the `release/3.0.0` branch of GitVersion it shows:
   "BranchName":"release/3.0.0",
   "Sha":"28c853159a46b5a87e6cc9c4f6e940c59d6bc68a",
   "NuGetVersionV2":"3.0.0-beta0001",
-  "NuGetVersion":"3.0.0-beta0001"
+  "NuGetVersion":"3.0.0-beta0001",
+  "CommitsSinceVersionSource":1,
+  "CommitsSinceVersionSourcePadded":"0001",
+  "CommitDate":"2014-03-06"
 }
 ```
 

src/GitVersionCore.Tests/ConfigProviderTests.CanWriteOutEffectiveConfiguration.approved.txt

@@ -7,6 +7,7 @@ minor-version-bump-message: '\+semver:\s?(feature|minor)'
 patch-version-bump-message: '\+semver:\s?(fix|patch)'
 legacy-semver-padding: 4
 build-metadata-padding: 4
+commits-since-version-source-padding: 4
 commit-message-incrementing: Enabled
 branches:
   master:

src/GitVersionCore.Tests/Fixtures/RepositoryFixtureBase.cs

@@ -148,7 +148,7 @@ string GetParticipant(string branch)
         return branch;
     }
 
-    VersionVariables GetVersion(IRepository repository = null, string commitId = null)
+    public VersionVariables GetVersion(IRepository repository = null, string commitId = null)
     {
         var gitVersionContext = new GitVersionContext(repository ?? Repository, configuration, IsForTrackedBranchOnly, commitId);
         var executeGitVersion = ExecuteGitVersion(gitVersionContext);

src/GitVersionCore.Tests/IntegrationTests/DocumentationSamples.cs

@@ -1,5 +1,6 @@
 using GitVersion;
 using NUnit.Framework;
+using Shouldly;
 
 [TestFixture]
 public class DocumentationSamples
@@ -390,6 +391,10 @@ public void GitHubFlowMajorRelease()
             fixture.ApplyTag("2.0.0-beta.1");
             fixture.AssertFullSemver("2.0.0-beta.1");
 
+            // test that the CommitsSinceVersionSource should still return commit count
+            var version = fixture.GetVersion();
+            version.CommitsSinceVersionSource.ShouldBe("2");
+
             // Make a commit after a tag should bump up the beta
             fixture.MakeACommit();
             fixture.AssertFullSemver("2.0.0-beta.2+3");

src/GitVersionCore.Tests/JsonVersionBuilderTests.Json.approved.txt

@@ -18,5 +18,7 @@
   "Sha":"commitSha",
   "NuGetVersionV2":"1.2.3-unstable0004",
   "NuGetVersion":"1.2.3-unstable0004",
+  "CommitsSinceVersionSource":5,
+  "CommitsSinceVersionSourcePadded":"0005",
   "CommitDate":"2014-03-06"
 }

src/GitVersionCore.Tests/TestEffectiveConfiguration.cs

@@ -21,12 +21,13 @@ public TestEffectiveConfiguration(
             string patchMessage = null,
             CommitMessageIncrementMode commitMessageMode = CommitMessageIncrementMode.Enabled,
             int legacySemVerPadding = 4,
-            int buildMetaDataPadding = 4) : 
+            int buildMetaDataPadding = 4,
+            int commitsSinceVersionSourcePadding = 4) : 
                 base(assemblyVersioningScheme, assemblyInformationalFormat, versioningMode, gitTagPrefix, tag, nextVersion, IncrementStrategy.Patch, 
                     branchPrefixToTrim, preventIncrementForMergedBranchVersion, tagNumberPattern, continuousDeploymentFallbackTag,
                     trackMergeTarget,
                     majorMessage, minorMessage, patchMessage,
-                    commitMessageMode, legacySemVerPadding, buildMetaDataPadding)
+                    commitMessageMode, legacySemVerPadding, buildMetaDataPadding, commitsSinceVersionSourcePadding)
         {
         }
     }

src/GitVersionCore.Tests/TestableVersionVariables.cs

@@ -4,7 +4,7 @@
 
     class TestableVersionVariables : VersionVariables
     {
-        public TestableVersionVariables(string major = "", string minor = "", string patch = "", string buildMetaData = "", string buildMetaDataPadded = "", string fullBuildMetaData = "", string branchName = "", string sha = "", string majorMinorPatch = "", string semVer = "", string legacySemVer = "", string legacySemVerPadded = "", string fullSemVer = "", string assemblySemVer = "", string preReleaseTag = "", string preReleaseTagWithDash = "", string informationalVersion = "", string commitDate = "", string nugetVersion = "", string nugetVersionV2 = null) : base(major, minor, patch, buildMetaData, buildMetaDataPadded, fullBuildMetaData, branchName, sha, majorMinorPatch, semVer, legacySemVer, legacySemVerPadded, fullSemVer, assemblySemVer, preReleaseTag, preReleaseTagWithDash, informationalVersion, commitDate, nugetVersion, nugetVersionV2)
+        public TestableVersionVariables(string major = "", string minor = "", string patch = "", string buildMetaData = "", string buildMetaDataPadded = "", string fullBuildMetaData = "", string branchName = "", string sha = "", string majorMinorPatch = "", string semVer = "", string legacySemVer = "", string legacySemVerPadded = "", string fullSemVer = "", string assemblySemVer = "", string preReleaseTag = "", string preReleaseTagWithDash = "", string informationalVersion = "", string commitDate = "", string nugetVersion = "", string nugetVersionV2 = "", string commitsSinceVersionSource = "", string commitsSinceVersionSourcePadded = "") : base(major, minor, patch, buildMetaData, buildMetaDataPadded, fullBuildMetaData, branchName, sha, majorMinorPatch, semVer, legacySemVer, legacySemVerPadded, fullSemVer, assemblySemVer, preReleaseTag, preReleaseTagWithDash, informationalVersion, commitDate, nugetVersion, nugetVersionV2, commitsSinceVersionSource, commitsSinceVersionSourcePadded)
         {
         }
     }

src/GitVersionCore.Tests/VariableProviderTests.ProvidesVariablesInContinuousDeliveryModeForPreRelease.approved.txt

@@ -18,5 +18,7 @@
   "Sha":"commitSha",
   "NuGetVersionV2":"1.2.3-unstable0004",
   "NuGetVersion":"1.2.3-unstable0004",
+  "CommitsSinceVersionSource":5,
+  "CommitsSinceVersionSourcePadded":"0005",
   "CommitDate":"2014-03-06"
 }

src/GitVersionCore.Tests/VariableProviderTests.ProvidesVariablesInContinuousDeliveryModeForPreReleaseWithPadding.approved.txt

@@ -18,5 +18,7 @@
   "Sha":"commitSha",
   "NuGetVersionV2":"1.2.3-unstable00004",
   "NuGetVersion":"1.2.3-unstable00004",
+  "CommitsSinceVersionSource":5,
+  "CommitsSinceVersionSourcePadded":"0005",
   "CommitDate":"2014-03-06"
 }

src/GitVersionCore.Tests/VariableProviderTests.ProvidesVariablesInContinuousDeliveryModeForStable.approved.txt

@@ -18,5 +18,7 @@
   "Sha":"commitSha",
   "NuGetVersionV2":"1.2.3",
   "NuGetVersion":"1.2.3",
+  "CommitsSinceVersionSource":5,
+  "CommitsSinceVersionSourcePadded":"0005",
   "CommitDate":"2014-03-06"
 }

src/GitVersionCore.Tests/VariableProviderTests.ProvidesVariablesInContinuousDeploymentModeForPreRelease.approved.txt

@@ -18,5 +18,7 @@
   "Sha":"commitSha",
   "NuGetVersionV2":"1.2.3-unstable0005",
   "NuGetVersion":"1.2.3-unstable0005",
+  "CommitsSinceVersionSource":5,
+  "CommitsSinceVersionSourcePadded":"0005",
   "CommitDate":"2014-03-06"
 }

src/GitVersionCore.Tests/VariableProviderTests.ProvidesVariablesInContinuousDeploymentModeForStable.approved.txt

@@ -18,5 +18,7 @@
   "Sha":"commitSha",
   "NuGetVersionV2":"1.2.3-ci0005",
   "NuGetVersion":"1.2.3-ci0005",
+  "CommitsSinceVersionSource":5,
+  "CommitsSinceVersionSourcePadded":"0005",
   "CommitDate":"2014-03-06"
 }

src/GitVersionCore.Tests/VariableProviderTests.ProvidesVariablesInContinuousDeploymentModeForStableWhenCurrentCommitIsTagged.approved.txt

@@ -18,5 +18,7 @@
   "Sha":"commitSha",
   "NuGetVersionV2":"1.2.3",
   "NuGetVersion":"1.2.3",
+  "CommitsSinceVersionSource":5,
+  "CommitsSinceVersionSourcePadded":"0005",
   "CommitDate":"2014-03-06"
 }

src/GitVersionCore.Tests/VariableProviderTests.cs

@@ -128,6 +128,7 @@ public void ProvidesVariablesInContinuousDeploymentModeForStableWhenCurrentCommi
             BuildMetaData =
             {
                 CommitsSinceTag = 5,
+                CommitsSinceVersionSource = 5,
                 Sha = "commitSha",
                 CommitDate = DateTimeOffset.Parse("2014-03-06 23:59:59Z")
             }

src/GitVersionCore/Configuration/Config.cs

@@ -41,6 +41,9 @@ public class Config
         [YamlMember(Alias = "build-metadata-padding")]
         public int? BuildMetaDataPadding { get; set; }
 
+        [YamlMember(Alias = "commits-since-version-source-padding")]
+        public int? CommitsSinceVersionSourcePadding { get; set; }
+
         [YamlMember(Alias = "commit-message-incrementing")]
         public CommitMessageIncrementMode? CommitMessageIncrementing { get; set; }
 

src/GitVersionCore/Configuration/ConfigurationProvider.cs

@@ -34,6 +34,7 @@ public static void ApplyDefaultsTo(Config config)
             config.CommitMessageIncrementing = config.CommitMessageIncrementing ?? CommitMessageIncrementMode.Enabled;
             config.LegacySemVerPadding = config.LegacySemVerPadding ?? 4;
             config.BuildMetaDataPadding = config.BuildMetaDataPadding ?? 4;
+            config.CommitsSinceVersionSourcePadding = config.CommitsSinceVersionSourcePadding ?? 4;
 
             var configBranches = config.Branches.ToList();
 

src/GitVersionCore/EffectiveConfiguration.cs

@@ -20,7 +20,8 @@ public EffectiveConfiguration(
             string patchVersionBumpMessage,
             CommitMessageIncrementMode commitMessageIncrementing,
             int legacySemVerPaddding,
-            int buildMetaDataPadding
+            int buildMetaDataPadding,
+            int commitsSinceVersionSourcePadding
             )
         {
             AssemblyVersioningScheme = assemblyVersioningScheme;
@@ -41,6 +42,7 @@ int buildMetaDataPadding
             CommitMessageIncrementing = commitMessageIncrementing;
             LegacySemVerPadding = legacySemVerPaddding;
             BuildMetaDataPadding = buildMetaDataPadding;
+            CommitsSinceVersionSourcePadding = commitsSinceVersionSourcePadding;
         }
 
         public VersioningMode VersioningMode { get; private set; }
@@ -81,6 +83,8 @@ int buildMetaDataPadding
         public int LegacySemVerPadding { get; private set; }
         public  int BuildMetaDataPadding { get; private set; }
 
+        public int CommitsSinceVersionSourcePadding { get; private set; }
+
         public CommitMessageIncrementMode CommitMessageIncrementing { get; private set; }
     }
 }

src/GitVersionCore/GitVersionContext.cs

@@ -120,7 +120,8 @@ void CalculateEffectiveConfiguration()
                 majorMessage, minorMessage, patchMessage,
                 commitMessageVersionBump,
                 configuration.LegacySemVerPadding.Value,
-                configuration.BuildMetaDataPadding.Value);
+                configuration.BuildMetaDataPadding.Value,
+                configuration.CommitsSinceVersionSourcePadding.Value);
         }
     }
 }

src/GitVersionCore/OutputVariables/VariableProvider.cs

@@ -17,6 +17,7 @@ public static VersionVariables GetVariablesFor(SemanticVersion semanticVersion,
 
                 // For continuous deployment the commits since tag gets promoted to the pre-release number
                 semanticVersion.PreReleaseTag.Number = semanticVersion.BuildMetaData.CommitsSinceTag;
+                semanticVersion.BuildMetaData.CommitsSinceVersionSource = semanticVersion.BuildMetaData.CommitsSinceTag ?? 0;
                 semanticVersion.BuildMetaData.CommitsSinceTag = null;
             }
 
@@ -60,7 +61,9 @@ public static VersionVariables GetVariablesFor(SemanticVersion semanticVersion,
                 informationalVersion,
                 semverFormatValues.CommitDate,
                 semverFormatValues.NuGetVersion,
-                semverFormatValues.NuGetVersionV2);
+                semverFormatValues.NuGetVersionV2,
+                semverFormatValues.CommitsSinceVersionSource,
+                semverFormatValues.CommitsSinceVersionSourcePadded);
 
             return variables;
         }

src/GitVersionCore/OutputVariables/VersionVariables.cs

@@ -7,7 +7,7 @@
     public class VersionVariables : IEnumerable<KeyValuePair<string, string>>
     {
         public VersionVariables(string major, string minor, string patch, string buildMetaData, string buildMetaDataPadded, string fullBuildMetaData, string branchName, string sha, string majorMinorPatch, string semVer, string legacySemVer, string legacySemVerPadded, string fullSemVer, string assemblySemVer, string preReleaseTag, string preReleaseTagWithDash, string informationalVersion,
-            string commitDate, string nugetVersion, string nugetVersionV2)
+            string commitDate, string nugetVersion, string nugetVersionV2, string commitsSinceVersionSource, string commitsSinceVersionSourcePadded)
         {
             Major = major;
             Minor = minor;
@@ -29,6 +29,8 @@ public VersionVariables(string major, string minor, string patch, string buildMe
             CommitDate = commitDate;
             NuGetVersion = nugetVersion;
             NuGetVersionV2 = nugetVersionV2;
+            CommitsSinceVersionSource = commitsSinceVersionSource;
+            CommitsSinceVersionSourcePadded = commitsSinceVersionSourcePadded;
         }
 
         public string Major { get; private set; }
@@ -50,6 +52,8 @@ public VersionVariables(string major, string minor, string patch, string buildMe
         public string Sha { get; private set; }
         public string NuGetVersionV2 { get; private set; }
         public string NuGetVersion { get; private set; }
+        public string CommitsSinceVersionSource { get; private set; }
+        public string CommitsSinceVersionSourcePadded { get; private set; }
 
         public static IEnumerable<string> AvailableVariables
         {

src/GitVersionCore/SemanticVersionBuildMetaData.cs

@@ -17,6 +17,7 @@ public class SemanticVersionBuildMetaData : IFormattable, IEquatable<SemanticVer
         public string Sha;
         public string OtherMetaData;
         public DateTimeOffset CommitDate;
+        public int CommitsSinceVersionSource;
 
         public SemanticVersionBuildMetaData()
         {
@@ -29,6 +30,7 @@ public SemanticVersionBuildMetaData(int? commitsSinceTag, string branch, string
             Branch = branch;
             CommitDate = commitDate;
             OtherMetaData = otherMetadata;
+            CommitsSinceVersionSource = commitsSinceTag ?? 0;
         }
 
         public SemanticVersionBuildMetaData(SemanticVersionBuildMetaData buildMetaData)
@@ -146,7 +148,10 @@ public static SemanticVersionBuildMetaData Parse(string buildMetaData)
             var parsed = ParseRegex.Match(buildMetaData);
 
             if (parsed.Groups["BuildNumber"].Success)
+            {
                 semanticVersionBuildMetaData.CommitsSinceTag = int.Parse(parsed.Groups["BuildNumber"].Value);
+                semanticVersionBuildMetaData.CommitsSinceVersionSource = semanticVersionBuildMetaData.CommitsSinceTag ?? 0;
+            }
 
             if (parsed.Groups["BranchName"].Success)
                 semanticVersionBuildMetaData.Branch = parsed.Groups["BranchName"].Value;

src/GitVersionCore/SemanticVersionFormatValues.cs

@@ -1,5 +1,7 @@
 namespace GitVersion
 {
+    using System.Globalization;
+
     public class SemanticVersionFormatValues
     {
         readonly SemanticVersion _semver;
@@ -112,5 +114,15 @@ public string DefaultInformationalVersion
         {
             get { return _semver.ToString("i"); }
         }
-}
+
+        public string CommitsSinceVersionSource
+        {
+            get { return _semver.BuildMetaData.CommitsSinceVersionSource.ToString(CultureInfo.InvariantCulture); }
+        }
+
+        public string CommitsSinceVersionSourcePadded
+        {
+            get { return _semver.BuildMetaData.CommitsSinceVersionSource.ToString(CultureInfo.InvariantCulture).PadLeft(_config.CommitsSinceVersionSourcePadding, '0'); }
+        }
+    }
 }

src/GitVersionCore/VersionCalculation/NextVersionCalculator.cs

@@ -23,17 +23,22 @@ public NextVersionCalculator(IBaseVersionCalculator baseVersionCalculator = null
 
         public SemanticVersion FindVersion(GitVersionContext context)
         {
+
+            SemanticVersion taggedSemanticVersion = null;
             // If current commit is tagged, don't do anything except add build metadata
             if (context.IsCurrentCommitTagged)
             {
                 // Will always be 0, don't bother with the +0 on tags
                 var semanticVersionBuildMetaData = metaDataCalculator.Create(context.CurrentCommit, context);
                 semanticVersionBuildMetaData.CommitsSinceTag = null;
+
+          
+
                 var semanticVersion = new SemanticVersion(context.CurrentCommitTaggedVersion)
                 {
                     BuildMetaData = semanticVersionBuildMetaData
                 };
-                return semanticVersion;
+                taggedSemanticVersion = semanticVersion;
             }
 
             var baseVersion = baseVersionFinder.GetBaseVersion(context);
@@ -52,7 +57,13 @@ public SemanticVersion FindVersion(GitVersionContext context)
 
             semver.BuildMetaData = metaDataCalculator.Create(baseVersion.BaseVersionSource, context);
 
-            return semver;
+            if (taggedSemanticVersion != null)
+            {
+                // set the commit count on the tagged ver
+                taggedSemanticVersion.BuildMetaData.CommitsSinceVersionSource = semver.BuildMetaData.CommitsSinceVersionSource;
+            }
+
+            return taggedSemanticVersion ?? semver;
         }
 
         void UpdatePreReleaseTag(GitVersionContext context, SemanticVersion semanticVersion, string branchNameOverride)

src/GitVersionTask.Tests/AssemblyInfoBuilderTests.VerifyAssemblyVersion_Major.approved.txt

@@ -40,6 +40,8 @@ namespace Fake
         public static string Sha = "commitSha";
         public static string NuGetVersionV2 = "2.3.4-beta0005";
         public static string NuGetVersion = "2.3.4-beta0005";
+        public static string CommitsSinceVersionSource = "6";
+        public static string CommitsSinceVersionSourcePadded = "0006";
         public static string CommitDate = "2014-03-06";
     }
 

src/GitVersionTask.Tests/AssemblyInfoBuilderTests.VerifyAssemblyVersion_MajorMinor.approved.txt

@@ -40,6 +40,8 @@ namespace Fake
         public static string Sha = "commitSha";
         public static string NuGetVersionV2 = "2.3.4-beta0005";
         public static string NuGetVersion = "2.3.4-beta0005";
+        public static string CommitsSinceVersionSource = "6";
+        public static string CommitsSinceVersionSourcePadded = "0006";
         public static string CommitDate = "2014-03-06";
     }
 

src/GitVersionTask.Tests/AssemblyInfoBuilderTests.VerifyAssemblyVersion_MajorMinorPatch.approved.txt

@@ -40,6 +40,8 @@ namespace Fake
         public static string Sha = "commitSha";
         public static string NuGetVersionV2 = "2.3.4-beta0005";
         public static string NuGetVersion = "2.3.4-beta0005";
+        public static string CommitsSinceVersionSource = "6";
+        public static string CommitsSinceVersionSourcePadded = "0006";
         public static string CommitDate = "2014-03-06";
     }
 

src/GitVersionTask.Tests/AssemblyInfoBuilderTests.VerifyAssemblyVersion_MajorMinorPatchTag.approved.txt

@@ -40,6 +40,8 @@ namespace Fake
         public static string Sha = "commitSha";
         public static string NuGetVersionV2 = "2.3.4-beta0005";
         public static string NuGetVersion = "2.3.4-beta0005";
+        public static string CommitsSinceVersionSource = "6";
+        public static string CommitsSinceVersionSourcePadded = "0006";
         public static string CommitDate = "2014-03-06";
     }
 

src/GitVersionTask.Tests/AssemblyInfoBuilderTests.VerifyAssemblyVersion_MajorMinorPatchTag_NugetAssemblyInfo.approved.txt

@@ -40,6 +40,8 @@ namespace Fake
         public static string Sha = "commitSha";
         public static string NuGetVersionV2 = "2.3.4-beta0005";
         public static string NuGetVersion = "2.3.4-beta0005";
+        public static string CommitsSinceVersionSource = "6";
+        public static string CommitsSinceVersionSourcePadded = "0006";
         public static string CommitDate = "2014-03-06";
     }
 

src/GitVersionTask.Tests/AssemblyInfoBuilderTests.VerifyAssemblyVersion_MajorMinorPatch_NugetAssemblyInfo.approved.txt

@@ -40,6 +40,8 @@ namespace Fake
         public static string Sha = "commitSha";
         public static string NuGetVersionV2 = "2.3.4-beta0005";
         public static string NuGetVersion = "2.3.4-beta0005";
+        public static string CommitsSinceVersionSource = "6";
+        public static string CommitsSinceVersionSourcePadded = "0006";
         public static string CommitDate = "2014-03-06";
     }
 

src/GitVersionTask.Tests/AssemblyInfoBuilderTests.VerifyAssemblyVersion_MajorMinor_NugetAssemblyInfo.approved.txt

@@ -40,6 +40,8 @@ namespace Fake
         public static string Sha = "commitSha";
         public static string NuGetVersionV2 = "2.3.4-beta0005";
         public static string NuGetVersion = "2.3.4-beta0005";
+        public static string CommitsSinceVersionSource = "6";
+        public static string CommitsSinceVersionSourcePadded = "0006";
         public static string CommitDate = "2014-03-06";
     }