GitTools#2340 implemented 'easier approach'

Author: BomBastiG

docs/input/docs/configuration.md

@@ -520,3 +520,13 @@ If the `pre-release-weight` is set, it would be added to the `PreReleaseNumber`
 to get a final `AssemblySemFileVer`, otherwise a branch specific default for
 `pre-release-weight` will be used in the calculation. Related Issues
 [1145](https://github.com/GitTools/GitVersion/issues/1145), [1366](https://github.com/GitTools/GitVersion/issues/1366)
+
+### prefer-branch-config-over-existing-tag
+
+If this is set true, GitVersion will prefer the configured branch (pre-release) tag
+over an existing git tag, when creating another tag for the same commit.
+Example: tag `1.1.0-alpha.42` was created while building the `develop` branch.
+Then `release/1.1.0` was created off this commit, without generating an empty commit.
+Building a release-candidate and running GitVersion on the release branch now will:
+- when set to `false` (default): create no new tag, using `1.1.0-alpha.42` again
+- when set to `true`: new tag e.g. `1.1.0-beta.1` will be created

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

@@ -25,6 +25,7 @@ branches:
     is-release-branch: false
     is-mainline: false
     pre-release-weight: 0
+    prefer-branch-config-over-existing-tag: false
   master:
     mode: ContinuousDelivery
     tag: ''
@@ -39,6 +40,7 @@ branches:
     is-release-branch: false
     is-mainline: true
     pre-release-weight: 55000
+    prefer-branch-config-over-existing-tag: false
   release:
     mode: ContinuousDelivery
     tag: beta
@@ -55,6 +57,7 @@ branches:
     is-release-branch: true
     is-mainline: false
     pre-release-weight: 30000
+    prefer-branch-config-over-existing-tag: false
   feature:
     mode: ContinuousDelivery
     tag: useBranchName
@@ -73,6 +76,7 @@ branches:
     is-release-branch: false
     is-mainline: false
     pre-release-weight: 30000
+    prefer-branch-config-over-existing-tag: false
   pull-request:
     mode: ContinuousDelivery
     tag: PullRequest
@@ -92,6 +96,7 @@ branches:
     is-release-branch: false
     is-mainline: false
     pre-release-weight: 30000
+    prefer-branch-config-over-existing-tag: false
   hotfix:
     mode: ContinuousDelivery
     tag: beta
@@ -107,6 +112,7 @@ branches:
     is-release-branch: false
     is-mainline: false
     pre-release-weight: 30000
+    prefer-branch-config-over-existing-tag: false
   support:
     mode: ContinuousDelivery
     tag: ''

src/GitVersionCore.Tests/Helpers/TestEffectiveConfiguration.cs

@@ -43,7 +43,7 @@ public TestEffectiveConfiguration(
                     majorMessage, minorMessage, patchMessage, noBumpMessage,
                     commitMessageMode, legacySemVerPadding, buildMetaDataPadding, commitsSinceVersionSourcePadding,
                     versionFilters ?? Enumerable.Empty<IVersionFilter>(),
-                    tracksReleaseBranches, isRelease, commitDateFormat, updateBuildNumber, 0, 0)
+                    tracksReleaseBranches, isRelease, commitDateFormat, updateBuildNumber, 0, 0, false)
         {
         }
     }

src/GitVersionCore.Tests/IntegrationTests/BranchWithoutCommitScenarios.cs

@@ -46,7 +46,7 @@ public void BetaBranchCreatedButStillOnTaggedAlphaCommitShouldCreateBetaVersion(
             {
                 Branches =
                 {
-                    { "release", new BranchConfig { Tag = "beta" } },
+                    { "release", new BranchConfig { Tag = "beta", PreferBranchConfigOverTag = true } },
                     { "develop", new BranchConfig { Tag = "alpha" } }
                 }
             };
@@ -58,9 +58,10 @@ public void BetaBranchCreatedButStillOnTaggedAlphaCommitShouldCreateBetaVersion(
 
             fixture.BranchTo("release/1.1.0"); // about to be released, no additional empty commit in this scenario!
             fixture.Checkout("release/1.1.0"); // still on the same commit, but another branch, choosing to build same code as beta now
-
-            // Assert
-            fixture.AssertFullSemver("1.1.0-beta.1", config); //Tag is an "alpha" tag from develop branch, only "beta" tags should count when on release branch. If no beta tag found, build new beta version on release branch.
+            
+			// Assert
+			fixture.AssertFullSemver("1.1.0-beta.1+0", config); //was 1.1.0-alpha.1, with the new config param 'prefer-branch-config-over-existing-tag' set to true should be 1.1.0-beta.1.
+                                                                //Tag is an "alpha" tag from develop branch, only "beta" tags should count when on release branch. If no beta tag found, build new beta version on release branch.
 
             fixture.Checkout("develop"); // back to develop
             fixture.AssertFullSemver("1.1.0-alpha.1", config); //will be 1.1.0-alpha.1 based on tag (as before)

src/GitVersionCore.Tests/Model/CommitDateTests.cs

@@ -29,7 +29,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, false, 0, 0)
+                                        "", true, "", "", false, "", "", "", "", CommitMessageIncrementMode.Enabled, 4, 4, 4, Enumerable.Empty<IVersionFilter>(), false, true, format, false, 0, 0, false)
                                 );
 
             Assert.That(formatValues.CommitDate, Is.EqualTo(expectedOutcome));

src/GitVersionCore/Configuration/ConfigExtensions.cs

@@ -79,6 +79,7 @@ public static EffectiveConfiguration CalculateEffectiveConfiguration(this Config
             var preventIncrementForMergedBranchVersion = currentBranchConfig.PreventIncrementOfMergedBranchVersion.Value;
             var trackMergeTarget = currentBranchConfig.TrackMergeTarget.Value;
             var preReleaseWeight = currentBranchConfig.PreReleaseWeight ?? 0;
+            var preferBranchConfigOverTag = currentBranchConfig.PreferBranchConfigOverTag ?? false;
 
             var nextVersion = configuration.NextVersion;
             var assemblyVersioningScheme = configuration.AssemblyVersioningScheme.Value;
@@ -114,7 +115,8 @@ public static EffectiveConfiguration CalculateEffectiveConfiguration(this Config
                 commitDateFormat,
                 updateBuildNumber,
                 preReleaseWeight,
-                tagPreReleaseWeight);
+                tagPreReleaseWeight,
+                preferBranchConfigOverTag);
         }
 
         public static string GetBranchSpecificTag(this EffectiveConfiguration configuration, ILog log, string branchFriendlyName, string branchNameOverride)

src/GitVersionCore/Model/Configuration/BranchConfig.cs

@@ -32,6 +32,7 @@ public BranchConfig(BranchConfig branchConfiguration)
             SourceBranches = branchConfiguration.SourceBranches;
             IsSourceBranchFor = branchConfiguration.IsSourceBranchFor;
             PreReleaseWeight = branchConfiguration.PreReleaseWeight;
+            PreferBranchConfigOverTag = branchConfiguration.PreferBranchConfigOverTag;
         }
 
         [YamlMember(Alias = "mode")]
@@ -79,6 +80,13 @@ public BranchConfig(BranchConfig branchConfiguration)
         [YamlMember(Alias = "pre-release-weight")]
         public int? PreReleaseWeight { get; set; }
 
+        /// <summary>
+        /// If true, the NextVersionCalculator will check that an existing tag is matching the configured tag for this branch.
+        /// If the tag isn't matching, a new tag with the configured string will be created.
+        /// </summary>
+        [YamlMember(Alias = "prefer-branch-config-over-existing-tag")]
+        public bool? PreferBranchConfigOverTag { get; set; }
+
         /// <summary>
         /// The name given to this configuration in the config file.
         /// </summary>
@@ -103,6 +111,7 @@ public void MergeTo([NotNull] BranchConfig targetConfig)
             targetConfig.IsReleaseBranch = this.IsReleaseBranch ?? targetConfig.IsReleaseBranch;
             targetConfig.IsMainline = this.IsMainline ?? targetConfig.IsMainline;
             targetConfig.PreReleaseWeight = this.PreReleaseWeight ?? targetConfig.PreReleaseWeight;
+            targetConfig.PreferBranchConfigOverTag = this.PreferBranchConfigOverTag ?? targetConfig.PreferBranchConfigOverTag;
         }
 
         public BranchConfig Apply([NotNull] BranchConfig overrides)
@@ -124,6 +133,7 @@ public static BranchConfig CreateDefaultBranchConfig(string name)
                 TracksReleaseBranches = false,
                 IsReleaseBranch = false,
                 IsMainline = false,
+                PreferBranchConfigOverTag = false,
             };
         }
     }

src/GitVersionCore/Model/Configuration/EffectiveConfiguration.cs

@@ -36,7 +36,8 @@ public EffectiveConfiguration(
             string commitDateFormat,
             bool updateBuildNumber,
             int preReleaseWeight,
-            int tagPreReleaseWeight)
+            int tagPreReleaseWeight,
+            bool preferBranchConfigOverTag)
         {
             AssemblyVersioningScheme = assemblyVersioningScheme;
             AssemblyFileVersioningScheme = assemblyFileVersioningScheme;
@@ -68,6 +69,7 @@ public EffectiveConfiguration(
             UpdateBuildNumber = updateBuildNumber;
             PreReleaseWeight = preReleaseWeight;
             TagPreReleaseWeight = tagPreReleaseWeight;
+            PreferBranchConfigOverTag = preferBranchConfigOverTag;
         }
 
         public bool TracksReleaseBranches { get; private set; }
@@ -128,5 +130,7 @@ public EffectiveConfiguration(
         public int PreReleaseWeight { get; private set; }
 
         public int TagPreReleaseWeight { get; private set; }
+
+        public bool PreferBranchConfigOverTag { get; private set; }
     }
 }

src/GitVersionCore/VersionCalculation/BaseVersionCalculators/VersionInBranchNameVersionStrategy.cs

@@ -28,7 +28,7 @@ public override IEnumerable<BaseVersion> GetVersions()
             return GetVersions(tagPrefixRegex, currentBranch);
         }
 
-        internal IEnumerable<BaseVersion> GetVersions(string tagPrefixRegex Branch currentBranch)
+        internal IEnumerable<BaseVersion> GetVersions(string tagPrefixRegex, Branch currentBranch)
         {
             if (!Context.FullConfiguration.IsReleaseBranch(currentBranch.NameWithoutOrigin()))
             {

src/GitVersionCore/VersionCalculation/NextVersionCalculator.cs

@@ -42,17 +42,27 @@ public SemanticVersion FindVersion()
 
             SemanticVersion taggedSemanticVersion = null;
 
+            var branchConfigHasPreReleaseTagConfigured = !string.IsNullOrEmpty(context.Configuration.Tag);
             if (context.IsCurrentCommitTagged)
             {
-                // Will always be 0, don't bother with the +0 on tags
-                var semanticVersionBuildMetaData = mainlineVersionCalculator.CreateVersionBuildMetaData(context.CurrentCommit);
-                semanticVersionBuildMetaData.CommitsSinceTag = null;
-
-                var semanticVersion = new SemanticVersion(context.CurrentCommitTaggedVersion)
+                // If configured, check if another tag with different branch tag is needed
+                if (context.Configuration.PreferBranchConfigOverTag && branchConfigHasPreReleaseTagConfigured
+                    && !context.CurrentCommitTaggedVersion.PreReleaseTag.Name.Equals(context.Configuration.Tag))
                 {
-                    BuildMetaData = semanticVersionBuildMetaData
-                };
-                taggedSemanticVersion = semanticVersion;
+                    log.Info($"Current commit tag does not match the current branch configured expectation. Create another one.");
+                }
+                else
+                {
+                    // Will always be 0, don't bother with the +0 on tags
+                    var semanticVersionBuildMetaData = mainlineVersionCalculator.CreateVersionBuildMetaData(context.CurrentCommit);
+                    semanticVersionBuildMetaData.CommitsSinceTag = null;
+
+                    var semanticVersion = new SemanticVersion(context.CurrentCommitTaggedVersion)
+                    {
+                        BuildMetaData = semanticVersionBuildMetaData
+                    };
+                    taggedSemanticVersion = semanticVersion;
+                }
             }
 
             var baseVersion = baseVersionCalculator.GetBaseVersion();
@@ -68,7 +78,6 @@ public SemanticVersion FindVersion()
             }
 
             var hasPreReleaseTag = semver.PreReleaseTag.HasTag();
-            var branchConfigHasPreReleaseTagConfigured = !string.IsNullOrEmpty(context.Configuration.Tag);
             var preReleaseTagDoesNotMatchConfiguration = hasPreReleaseTag && branchConfigHasPreReleaseTagConfigured && semver.PreReleaseTag.Name != context.Configuration.Tag;
             if (!semver.PreReleaseTag.HasTag() && branchConfigHasPreReleaseTagConfigured || preReleaseTagDoesNotMatchConfiguration)
             {