Adding support to specify pre-release-weight for branch specific configs and leverage the same using a new GitVersion variable WeightedPreReleaseNumber

ruhullahshah · Ruh Ullah Shah · commit 5d2ca54e985c · 2019-02-27T13:07:06.000+01:00
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -206,6 +206,7 @@ branches:
     track-merge-target: false
     tracks-release-branches: false
     is-release-branch: true
+    pre-release-weight: 1000
   feature:
     regex: ^features?[/-]
     mode: ContinuousDelivery
@@ -385,3 +386,6 @@ Indicates this branch config represents a release branch in GitFlow.
 
 ### is-mainline
 When using Mainline mode, this indicates that this branch is a mainline. By default support/ and master are mainlines.
+
+### pre-release-weight
+Provides a way to translate the `PreReleaseLabel` ([variables](/more-info/variables)) to a numeric value in order to avoid version collisions across different branches. For example, a release branch created after "1.2.3-alpha.55" results in "1.2.3-beta.1" and thus e.g. "1.2.3-alpha.4" and "1.2.3-beta.4" would have the same file version: "1.2.3.4". Related Issues [1145](https://github.com/GitTools/GitVersion/issues/1145), [1366](https://github.com/GitTools/GitVersion/issues/1366)
diff --git a/docs/more-info/variables.md b/docs/more-info/variables.md
@@ -11,6 +11,7 @@ For the `release/3.0.0` branch of GitVersion it shows:
   "PreReleaseTagWithDash":"-beta.1",
   "PreReleaseLabel":"beta",
   "PreReleaseNumber":1,
+  "WeightedPreReleaseNumber":1001
   "BuildMetaData":1,
   "BuildMetaDataPadded": "0001",
   "FullBuildMetaData":"1.Branch.release/3.0.0.Sha.28c853159a46b5a87e6cc9c4f6e940c59d6bc68a",
@@ -40,3 +41,6 @@ For the `release/3.0.0` branch of GitVersion it shows:
 
 This is a common approach that gives you the ability to roll out hot fixes to your assembly without breaking existing applications that may be referencing it. You are still able to get the full version number if you need to by looking at its file version number.
 
+#### What is WeightedPreReleaseNumber?
+
+It is a summation of branch specific `pre-release-weight` and the `PreReleaseNumber`. It can be used to obtain a monotonically increasing version number across the branches.
diff --git a/src/GitVersionCore.Tests/CommitDateTests.cs b/src/GitVersionCore.Tests/CommitDateTests.cs
@@ -26,7 +26,7 @@ public void CommitDateFormatTest(string format, string expectedOutcome)
                                     },
                                     new EffectiveConfiguration(
                                         AssemblyVersioningScheme.MajorMinorPatch, AssemblyFileVersioningScheme.MajorMinorPatch, "", "", "", VersioningMode.ContinuousDelivery, "", "", "", IncrementStrategy.Inherit,
-                                        "", true, "", "", false, "", "", "", "", CommitMessageIncrementMode.Enabled, 4, 4, 4, Enumerable.Empty<IVersionFilter>(), false, true, format)
+                                        "", true, "", "", false, "", "", "", "", CommitMessageIncrementMode.Enabled, 4, 4, 4, Enumerable.Empty<IVersionFilter>(), false, true, format, 0)
                                 );
 
             Assert.That(formatValues.CommitDate, Is.EqualTo(expectedOutcome));
diff --git a/src/GitVersionCore.Tests/IntegrationTests/ReleaseBranchScenarios.cs b/src/GitVersionCore.Tests/IntegrationTests/ReleaseBranchScenarios.cs
@@ -623,4 +623,31 @@ public void FeatureOnRelease_FeatureBranchNotDeleted()
             fixture.AssertFullSemver(config, "4.5.0-beta.2");
         }
     }
+    
+    [Test]
+    public void AssemblySemFileVerShouldBeWeightedByPreReleaseWeight()
+    {
+        var config = new Config
+        {
+            AssemblyFileVersioningFormat = "{Major}.{Minor}.{Patch}.{WeightedPreReleaseNumber}",
+            Branches =
+            {
+                { "release", new BranchConfig
+                    {
+                        PreReleaseWeight = 1000
+                    }
+                }
+            }
+        };
+        using (var fixture = new EmptyRepositoryFixture())
+        {
+            fixture.Repository.MakeATaggedCommit("1.0.3");
+            fixture.Repository.MakeCommits(5);
+            fixture.Repository.CreateBranch("release-2.0.0");
+            fixture.Checkout("release-2.0.0");
+            ConfigurationProvider.ApplyDefaultsTo(config);
+            var variables = fixture.GetVersion(config);
+            Assert.AreEqual(variables.AssemblySemFileVer, "2.0.0.1001");
+        }
+    }
 }
diff --git a/src/GitVersionCore.Tests/TestEffectiveConfiguration.cs b/src/GitVersionCore.Tests/TestEffectiveConfiguration.cs
@@ -40,7 +40,7 @@ public TestEffectiveConfiguration(
                     majorMessage, minorMessage, patchMessage, noBumpMessage,
                     commitMessageMode, legacySemVerPadding, buildMetaDataPadding, commitsSinceVersionSourcePadding,
                     versionFilters ?? Enumerable.Empty<IVersionFilter>(),
-                    tracksReleaseBranches, isRelease, commitDateFormat)
+                    tracksReleaseBranches, isRelease, commitDateFormat, 0)
         {
         }
     }
diff --git a/src/GitVersionCore.Tests/TestableVersionVariables.cs b/src/GitVersionCore.Tests/TestableVersionVariables.cs
@@ -4,7 +4,22 @@
 
     class TestableVersionVariables : VersionVariables
     {
-        public TestableVersionVariables(string major = "", string minor = "", string patch = "", string buildMetaData = "", string buildMetaDataPadded = "", string fullBuildMetaData = "", string branchName = "", string sha = "", string shortSha = "", string majorMinorPatch = "", string semVer = "", string legacySemVer = "", string legacySemVerPadded = "", string fullSemVer = "", string assemblySemVer = "", string assemblySemFileVer = "", string preReleaseTag = "", string preReleaseTagWithDash = "", string preReleaseLabel = "", string preReleaseNumber = "", string informationalVersion = "", string commitDate = "", string nugetVersion = "", string nugetVersionV2 = "", string nugetPreReleaseTag = "", string nugetPreReleaseTagV2 = "", string commitsSinceVersionSource = "", string commitsSinceVersionSourcePadded = "") : base(major, minor, patch, buildMetaData, buildMetaDataPadded, fullBuildMetaData, branchName, sha, shortSha, majorMinorPatch, semVer, legacySemVer, legacySemVerPadded, fullSemVer, assemblySemVer, assemblySemFileVer, preReleaseTag, preReleaseTagWithDash, preReleaseLabel, preReleaseNumber, informationalVersion, commitDate, nugetVersion, nugetVersionV2, nugetPreReleaseTag, nugetPreReleaseTagV2, commitsSinceVersionSource, commitsSinceVersionSourcePadded)
+        public TestableVersionVariables(
+            string major = "", string minor = "", string patch = "", string buildMetaData = "", 
+            string buildMetaDataPadded = "", string fullBuildMetaData = "", string branchName = "", 
+            string sha = "", string shortSha = "", string majorMinorPatch = "", string semVer = "", 
+            string legacySemVer = "", string legacySemVerPadded = "", string fullSemVer = "", 
+            string assemblySemVer = "", string assemblySemFileVer = "", string preReleaseTag = "", 
+            string preReleaseTagWithDash = "", string preReleaseLabel = "", string preReleaseNumber = "",
+            string weightedPreReleaseNumber = "", string informationalVersion = "", string commitDate = "", 
+            string nugetVersion = "", string nugetVersionV2 = "", string nugetPreReleaseTag = "", 
+            string nugetPreReleaseTagV2 = "", string commitsSinceVersionSource = "",
+            string commitsSinceVersionSourcePadded = "") : base(
+                major, minor, patch, buildMetaData, buildMetaDataPadded, fullBuildMetaData, branchName, 
+                sha, shortSha, majorMinorPatch, semVer, legacySemVer, legacySemVerPadded, fullSemVer, 
+                assemblySemVer, assemblySemFileVer, preReleaseTag, weightedPreReleaseNumber, preReleaseTagWithDash, 
+                preReleaseLabel, preReleaseNumber, informationalVersion, commitDate, nugetVersion, nugetVersionV2, 
+                nugetPreReleaseTag, nugetPreReleaseTagV2, commitsSinceVersionSource, commitsSinceVersionSourcePadded)
         {
         }
     }
diff --git a/src/GitVersionCore/Configuration/BranchConfig.cs b/src/GitVersionCore/Configuration/BranchConfig.cs
@@ -28,6 +28,7 @@ public BranchConfig(BranchConfig branchConfiguration)
             Name = branchConfiguration.Name;
             SourceBranches = branchConfiguration.SourceBranches;
             IsSourceBranchFor = branchConfiguration.IsSourceBranchFor;
+            PreReleaseWeight = branchConfiguration.PreReleaseWeight;
         }
 
         [YamlMember(Alias = "mode")]
@@ -72,6 +73,9 @@ public BranchConfig(BranchConfig branchConfiguration)
         [YamlMember(Alias = "is-mainline")]
         public bool? IsMainline { get; set; }
 
+        [YamlMember(Alias = "pre-release-weight")]
+        public int? PreReleaseWeight { get; set; }
+
         /// <summary>
         /// The name given to this configuration in the config file.
         /// </summary>
diff --git a/src/GitVersionCore/Configuration/ConfigurationProvider.cs b/src/GitVersionCore/Configuration/ConfigurationProvider.cs
@@ -231,6 +231,7 @@ public static void ApplyBranchDefaults(Config config,
             branchConfig.TracksReleaseBranches = branchConfig.TracksReleaseBranches ?? tracksReleaseBranches;
             branchConfig.IsReleaseBranch = branchConfig.IsReleaseBranch ?? isReleaseBranch;
             branchConfig.IsMainline = branchConfig.IsMainline ?? isMainline;
+            branchConfig.PreReleaseWeight = branchConfig.PreReleaseWeight ?? 0;
         }
 
         static Config ReadConfig(string workingDirectory, IFileSystem fileSystem)
diff --git a/src/GitVersionCore/EffectiveConfiguration.cs b/src/GitVersionCore/EffectiveConfiguration.cs
@@ -32,7 +32,8 @@ public EffectiveConfiguration(
             IEnumerable<IVersionFilter> versionFilters,
             bool tracksReleaseBranches,
             bool isCurrentBranchRelease,
-            string commitDateFormat)
+            string commitDateFormat,
+            int preReleaseWeight)
         {
             AssemblyVersioningScheme = assemblyVersioningScheme;
             AssemblyFileVersioningScheme = assemblyFileVersioningScheme;
@@ -61,6 +62,7 @@ public EffectiveConfiguration(
             TracksReleaseBranches = tracksReleaseBranches;
             IsCurrentBranchRelease = isCurrentBranchRelease;
             CommitDateFormat = commitDateFormat;
+            PreReleaseWeight = preReleaseWeight;
         }
 
         public bool TracksReleaseBranches { get; private set; }
@@ -115,5 +117,7 @@ public EffectiveConfiguration(
         public IEnumerable<IVersionFilter> VersionFilters { get; private set; }
 
         public string CommitDateFormat { get; private set; }
+
+        public int PreReleaseWeight { get; private set; }
     }
 }
diff --git a/src/GitVersionCore/GitVersionContext.cs b/src/GitVersionCore/GitVersionContext.cs
@@ -117,6 +117,7 @@ void CalculateEffectiveConfiguration()
             var incrementStrategy = currentBranchConfig.Increment.Value;
             var preventIncrementForMergedBranchVersion = currentBranchConfig.PreventIncrementOfMergedBranchVersion.Value;
             var trackMergeTarget = currentBranchConfig.TrackMergeTarget.Value;
+            var preReleaseWeight = currentBranchConfig.PreReleaseWeight ?? 0;
 
             var nextVersion = FullConfiguration.NextVersion;
             var assemblyVersioningScheme = FullConfiguration.AssemblyVersioningScheme.Value;
@@ -148,7 +149,8 @@ void CalculateEffectiveConfiguration()
                 FullConfiguration.Ignore.ToFilters(),
                 currentBranchConfig.TracksReleaseBranches.Value,
                 currentBranchConfig.IsReleaseBranch.Value,
-                commitDateFormat);
+                commitDateFormat,
+                preReleaseWeight);
         }
 
         private static Branch GetTargetBranch(IRepository repository, string targetBranch)
diff --git a/src/GitVersionCore/OutputVariables/VariableProvider.cs b/src/GitVersionCore/OutputVariables/VariableProvider.cs
@@ -72,6 +72,7 @@ public static VersionVariables GetVariablesFor(SemanticVersion semanticVersion,
                 semverFormatValues.PreReleaseTagWithDash,
                 semverFormatValues.PreReleaseLabel,
                 semverFormatValues.PreReleaseNumber,
+                semverFormatValues.WeightedPreReleaseNumber,
                 informationalVersion,
                 semverFormatValues.CommitDate,
                 semverFormatValues.NuGetVersion,
diff --git a/src/GitVersionCore/OutputVariables/VersionVariables.cs b/src/GitVersionCore/OutputVariables/VersionVariables.cs
@@ -32,6 +32,7 @@ public VersionVariables(string major,
                                 string preReleaseTagWithDash,
                                 string preReleaseLabel,
                                 string preReleaseNumber,
+                                string weightedPreReleaseNumber,
                                 string informationalVersion,
                                 string commitDate,
                                 string nugetVersion,
@@ -61,6 +62,7 @@ public VersionVariables(string major,
             PreReleaseTagWithDash = preReleaseTagWithDash;
             PreReleaseLabel = preReleaseLabel;
             PreReleaseNumber = preReleaseNumber;
+            WeightedPreReleaseNumber = weightedPreReleaseNumber;
             InformationalVersion = informationalVersion;
             CommitDate = commitDate;
             NuGetVersion = nugetVersion;
@@ -78,6 +80,7 @@ public VersionVariables(string major,
         public string PreReleaseTagWithDash { get; private set; }
         public string PreReleaseLabel { get; private set; }
         public string PreReleaseNumber { get; private set; }
+        public string WeightedPreReleaseNumber { get; private set; }
         public string BuildMetaData { get; private set; }
         public string BuildMetaDataPadded { get; private set; }
         public string FullBuildMetaData { get; private set; }
diff --git a/src/GitVersionCore/SemanticVersionFormatValues.cs b/src/GitVersionCore/SemanticVersionFormatValues.cs
@@ -48,6 +48,11 @@ public string PreReleaseNumber
             get { return _semver.PreReleaseTag.HasTag() ? _semver.PreReleaseTag.Number.ToString() : null; }
         }
 
+        public string WeightedPreReleaseNumber
+        {
+            get { return _semver.PreReleaseTag.HasTag() ? (_semver.PreReleaseTag.Number + _config.PreReleaseWeight).ToString() : null; }
+        }
+
         public string BuildMetaData
         {
             get { return _semver.BuildMetaData; }
diff --git a/src/GitVersionExe.Tests/TestEffectiveConfiguration.cs b/src/GitVersionExe.Tests/TestEffectiveConfiguration.cs
@@ -40,7 +40,7 @@ public TestEffectiveConfiguration(
                     majorMessage, minorMessage, patchMessage, noBumpMessage,
                     commitMessageMode, legacySemVerPadding, buildMetaDataPadding, commitsSinceVersionSourcePadding,
                     versionFilters ?? Enumerable.Empty<IVersionFilter>(),
-                    tracksReleaseBranches, isRelease, commitDateFormat)
+                    tracksReleaseBranches, isRelease, commitDateFormat, 0)
 
         {
         }
diff --git a/src/GitVersionTask.Tests/Helpers/TestEffectiveConfiguration.cs b/src/GitVersionTask.Tests/Helpers/TestEffectiveConfiguration.cs
@@ -40,7 +40,7 @@ public TestEffectiveConfiguration(
                     majorMessage, minorMessage, patchMessage, noBumpMessage,
                     commitMessageMode, legacySemVerPadding, buildMetaDataPadding, commitsSinceVersionSourcePadding,
                     versionFilters ?? Enumerable.Empty<IVersionFilter>(),
-                    tracksReleaseBranches, isRelease, commitDateFormat)
+                    tracksReleaseBranches, isRelease, commitDateFormat, 0)
         {
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public TestEffectiveConfiguration(`
`40`	`40`	`majorMessage, minorMessage, patchMessage, noBumpMessage,`
`41`	`41`	`commitMessageMode, legacySemVerPadding, buildMetaDataPadding, commitsSinceVersionSourcePadding,`
`42`	`42`	`versionFilters ?? Enumerable.Empty<IVersionFilter>(),`
`43`		`- tracksReleaseBranches, isRelease, commitDateFormat)`
	`43`	`+ tracksReleaseBranches, isRelease, commitDateFormat, 0)`
`44`	`44`	`{`
`45`	`45`	`}`
`46`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,22 @@`
`4`	`4`
`5`	`5`	`class TestableVersionVariables : VersionVariables`
`6`	`6`	`{`
`7`		- public TestableVersionVariables(string major = "", string minor = "", string patch = "", string buildMetaData = "", string buildMetaDataPadded = "", string fullBuildMetaData = "", string branchName = "", string sha = "", string shortSha = "", string majorMinorPatch = "", string semVer = "", string legacySemVer = "", string legacySemVerPadded = "", string fullSemVer = "", string assemblySemVer = "", string assemblySemFileVer = "", string preReleaseTag = "", string preReleaseTagWithDash = "", string preReleaseLabel = "", string preReleaseNumber = "", string informationalVersion = "", string commitDate = "", string nugetVersion = "", string nugetVersionV2 = "", string nugetPreReleaseTag = "", string nugetPreReleaseTagV2 = "", string commitsSinceVersionSource = "", string commitsSinceVersionSourcePadded = "") : base(major, minor, patch, buildMetaData, buildMetaDataPadded, fullBuildMetaData, branchName, sha, shortSha, majorMinorPatch, semVer, legacySemVer, legacySemVerPadded, fullSemVer, assemblySemVer, assemblySemFileVer, preReleaseTag, preReleaseTagWithDash, preReleaseLabel, preReleaseNumber, informationalVersion, commitDate, nugetVersion, nugetVersionV2, nugetPreReleaseTag, nugetPreReleaseTagV2, commitsSinceVersionSource, commitsSinceVersionSourcePadded)
	`7`	`+ public TestableVersionVariables(`
	`8`	`+ string major = "", string minor = "", string patch = "", string buildMetaData = "",`
	`9`	`+ string buildMetaDataPadded = "", string fullBuildMetaData = "", string branchName = "",`
	`10`	`+ string sha = "", string shortSha = "", string majorMinorPatch = "", string semVer = "",`
	`11`	`+ string legacySemVer = "", string legacySemVerPadded = "", string fullSemVer = "",`
	`12`	`+ string assemblySemVer = "", string assemblySemFileVer = "", string preReleaseTag = "",`
	`13`	`+ string preReleaseTagWithDash = "", string preReleaseLabel = "", string preReleaseNumber = "",`
	`14`	`+ string weightedPreReleaseNumber = "", string informationalVersion = "", string commitDate = "",`
	`15`	`+ string nugetVersion = "", string nugetVersionV2 = "", string nugetPreReleaseTag = "",`
	`16`	`+ string nugetPreReleaseTagV2 = "", string commitsSinceVersionSource = "",`
	`17`	`+ string commitsSinceVersionSourcePadded = "") : base(`
	`18`	`+ major, minor, patch, buildMetaData, buildMetaDataPadded, fullBuildMetaData, branchName,`
	`19`	`+ sha, shortSha, majorMinorPatch, semVer, legacySemVer, legacySemVerPadded, fullSemVer,`
	`20`	`+ assemblySemVer, assemblySemFileVer, preReleaseTag, weightedPreReleaseNumber, preReleaseTagWithDash,`
	`21`	`+ preReleaseLabel, preReleaseNumber, informationalVersion, commitDate, nugetVersion, nugetVersionV2,`
	`22`	`+ nugetPreReleaseTag, nugetPreReleaseTagV2, commitsSinceVersionSource, commitsSinceVersionSourcePadded)`
`8`	`23`	`{`
`9`	`24`	`}`
`10`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -231,6 +231,7 @@ public static void ApplyBranchDefaults(Config config,`
`231`	`231`	`branchConfig.TracksReleaseBranches = branchConfig.TracksReleaseBranches ?? tracksReleaseBranches;`
`232`	`232`	`branchConfig.IsReleaseBranch = branchConfig.IsReleaseBranch ?? isReleaseBranch;`
`233`	`233`	`branchConfig.IsMainline = branchConfig.IsMainline ?? isMainline;`
	`234`	`+ branchConfig.PreReleaseWeight = branchConfig.PreReleaseWeight ?? 0;`
`234`	`235`	`}`
`235`	`236`
`236`	`237`	`static Config ReadConfig(string workingDirectory, IFileSystem fileSystem)`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,8 @@ public EffectiveConfiguration(`
`32`	`32`	`IEnumerable<IVersionFilter> versionFilters,`
`33`	`33`	`bool tracksReleaseBranches,`
`34`	`34`	`bool isCurrentBranchRelease,`
`35`		`- string commitDateFormat)`
	`35`	`+ string commitDateFormat,`
	`36`	`+ int preReleaseWeight)`
`36`	`37`	`{`
`37`	`38`	`AssemblyVersioningScheme = assemblyVersioningScheme;`
`38`	`39`	`AssemblyFileVersioningScheme = assemblyFileVersioningScheme;`
`@@ -61,6 +62,7 @@ public EffectiveConfiguration(`
`61`	`62`	`TracksReleaseBranches = tracksReleaseBranches;`
`62`	`63`	`IsCurrentBranchRelease = isCurrentBranchRelease;`
`63`	`64`	`CommitDateFormat = commitDateFormat;`
	`65`	`+ PreReleaseWeight = preReleaseWeight;`
`64`	`66`	`}`
`65`	`67`
`66`	`68`	`public bool TracksReleaseBranches { get; private set; }`
`@@ -115,5 +117,7 @@ public EffectiveConfiguration(`
`115`	`117`	`public IEnumerable<IVersionFilter> VersionFilters { get; private set; }`
`116`	`118`
`117`	`119`	`public string CommitDateFormat { get; private set; }`
	`120`	`+`
	`121`	`+ public int PreReleaseWeight { get; private set; }`
`118`	`122`	`}`
`119`	`123`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,11 @@ public string PreReleaseNumber`
`48`	`48`	`get { return _semver.PreReleaseTag.HasTag() ? _semver.PreReleaseTag.Number.ToString() : null; }`
`49`	`49`	`}`
`50`	`50`
	`51`	`+ public string WeightedPreReleaseNumber`
	`52`	`+ {`
	`53`	`+ get { return _semver.PreReleaseTag.HasTag() ? (_semver.PreReleaseTag.Number + _config.PreReleaseWeight).ToString() : null; }`
	`54`	`+ }`
	`55`	`+`
`51`	`56`	`public string BuildMetaData`
`52`	`57`	`{`
`53`	`58`	`get { return _semver.BuildMetaData; }`