Finalizing the configuration of GitFlow and GitHubFlow workflow and align with the Mainline version strategy

Author: HHobeck

BREAKING_CHANGES.md

@@ -56,6 +56,7 @@
 *   The initialization wizard has been removed.
 *   On the `develop`, `release` and `hotfix` branch the introduced branch related property `prevent-increment.when-current-commit-tagged` has been set to `false` to get the incremented instead of the tagged semantic version.
 *   When setting the "ignore commits before" parameter to a future value, an exception will occur if no commits are found on the current branch. This behavior mimics that of an empty repository.
+*   In the Git Flow workflows e.g. release/next yields to a patch version. If you have a tag 1.0.0 on main and branch from main to release/1.0.1 branch then the next version number will be 1.1.0. Because in the Git Flow workflow you have an addition IsRelease branch configuration with name hotfix this is expected. If you want the 1.0.1 as a next version you need to branch to hotfix/1.0.1 or hotfix/next and not release. In GitHub Flow workflow it is not a problem because there the increment is set to patch for release branch.
 
 ## v5.0.0
 

src/GitVersion.Core.Tests/IntegrationTests/CompareTheDifferentWhenUsingTrunkBasedVersionStrategyWithGitFlow.cs

@@ -616,29 +616,13 @@ public void EnsureFeatureDevelopmentWithDevelopBranchFast(bool useTrunkBased)
 
         fixture.BranchTo("feature/foo");
 
-        if (useTrunkBased)
-        {
-            // ❔ expected: "0.1.0-foo.1+0"
-            fixture.AssertFullSemver("0.0.2-foo.1+0", configuration);
-        }
-        else
-        {
-            // ✅ succeeds as expected
-            fixture.AssertFullSemver("0.1.0-foo.1+0", configuration);
-        }
+        // ✅ succeeds as expected
+        fixture.AssertFullSemver("0.1.0-foo.1+0", configuration);
 
         fixture.MakeACommit("B");
 
-        if (useTrunkBased)
-        {
-            // ❔ expected: "0.1.0-foo.1+1"
-            fixture.AssertFullSemver("0.0.2-foo.1+1", configuration);
-        }
-        else
-        {
-            // ✅ succeeds as expected
-            fixture.AssertFullSemver("0.1.0-foo.1+1", configuration);
-        }
+        // ✅ succeeds as expected
+        fixture.AssertFullSemver("0.1.0-foo.1+1", configuration);
 
         fixture.ApplyTag("0.1.0-foo.1");
 
@@ -946,31 +930,15 @@ public void EnsureBugFixWithDevelopBranchFast(bool useTrunkBased)
         fixture.BranchTo("pull/2/merge");
         fixture.MergeNoFF("hotfix/foo");
 
-        if (useTrunkBased)
-        {
-            // ❔ expected: "0.1.0-PullRequest2.4"
-            fixture.AssertFullSemver("0.0.2-PullRequest2.4", configuration);
-        }
-        else
-        {
-            // ✅ succeeds as expected
-            fixture.AssertFullSemver("0.1.0-PullRequest2.4", configuration);
-        }
+        // ✅ succeeds as expected
+        fixture.AssertFullSemver("0.1.0-PullRequest2.4", configuration);
 
         fixture.Checkout("main");
         fixture.BranchTo("pull/3/merge");
         fixture.MergeNoFF("hotfix/foo");
 
-        if (useTrunkBased)
-        {
-            // ✅ succeeds as expected
-            fixture.AssertFullSemver("0.0.2-PullRequest3.4", configuration);
-        }
-        else
-        {
-            // ❔ expected: "0.0.2-PullRequest3.4"
-            fixture.AssertFullSemver("0.1.0-PullRequest3.4", configuration);
-        }
+        // ❔ expected: "0.0.2-PullRequest3.4"
+        fixture.AssertFullSemver("0.1.0-PullRequest3.4", configuration);
 
         fixture.Checkout("hotfix/foo");
         fixture.MergeTo("main", removeBranchAfterMerging: true);
@@ -985,26 +953,6 @@ public void EnsureBugFixWithDevelopBranchFast(bool useTrunkBased)
         fixture.AssertFullSemver("0.0.3-1", configuration);
     }
 
-    [Test]
-    public void JustATest()
-    {
-        var configuration = configurationBuilder.WithVersionStrategy(VersionStrategies.TrunkBased).Build();
-
-        using var fixture = new EmptyRepositoryFixture("main");
-
-        fixture.MakeACommit("A");
-
-        // ✅ succeeds as expected
-        fixture.AssertFullSemver("0.0.1-1", configuration);
-
-        fixture.ApplyTag("0.1.0");
-
-        for (int i = 0; i < 10; i++) fixture.MakeACommit();
-
-        // ✅ succeeds as expected
-        fixture.AssertFullSemver("0.1.10-1", configuration);
-    }
-
     [TestCase(false)]
     [TestCase(true)]
     public void EnsureFeatureDevelopmentWithReleaseNextBranch(bool useTrunkBased)

src/GitVersion.Core/Git/ReferenceName.cs

@@ -54,7 +54,7 @@ public static bool TryParse([NotNullWhen(true)] out ReferenceName? value, string
             value = new(canonicalName);
         }
 
-        return value != null;
+        return value is not null;
     }
 
     public static ReferenceName FromBranchName(string branchName)
@@ -77,6 +77,15 @@ public static ReferenceName FromBranchName(string branchName)
     public override int GetHashCode() => equalityHelper.GetHashCode(this);
     public override string ToString() => Friendly;
 
+    public static bool operator ==(ReferenceName? left, ReferenceName? right)
+    {
+        if (ReferenceEquals(left, right)) return true;
+        if (left is null || right is null) return false;
+        return left.Equals(right);
+    }
+
+    public static bool operator !=(ReferenceName? left, ReferenceName? right) => !(left == right);
+
     public bool TryGetSemanticVersion([NotNullWhen(true)] out (SemanticVersion Value, string? Name) result,
                                       Regex versionPatternRegex,
                                       string? tagPrefix,

src/GitVersion.Core/MergeMessage.cs

@@ -100,7 +100,7 @@ public static bool TryParse(
         mergeMessage = null;
 
         var mergedBranch = new MergeMessage(mergeCommit.Message, configuration).MergedBranch;
-        var isReleaseBranch = mergedBranch != null && configuration.IsReleaseBranch(mergedBranch);
+        var isReleaseBranch = mergedBranch is not null && configuration.IsReleaseBranch(mergedBranch);
         var isValidMergeCommit = mergeCommit.IsMergeCommit() || isReleaseBranch;
 
         if (isValidMergeCommit)

src/GitVersion.Core/PublicAPI.Unshipped.txt

@@ -769,6 +769,8 @@ static GitVersion.Git.BranchCommit.operator !=(GitVersion.Git.BranchCommit left,
 static GitVersion.Git.BranchCommit.operator ==(GitVersion.Git.BranchCommit left, GitVersion.Git.BranchCommit right) -> bool
 static GitVersion.Git.CommitExtensions.IsMergeCommit(this GitVersion.Git.ICommit! source) -> bool
 static GitVersion.Git.ReferenceName.FromBranchName(string! branchName) -> GitVersion.Git.ReferenceName!
+static GitVersion.Git.ReferenceName.operator !=(GitVersion.Git.ReferenceName? left, GitVersion.Git.ReferenceName? right) -> bool
+static GitVersion.Git.ReferenceName.operator ==(GitVersion.Git.ReferenceName? left, GitVersion.Git.ReferenceName? right) -> bool
 static GitVersion.Git.ReferenceName.Parse(string! canonicalName) -> GitVersion.Git.ReferenceName!
 static GitVersion.Git.ReferenceName.TryParse(out GitVersion.Git.ReferenceName? value, string! canonicalName) -> bool
 static GitVersion.Helpers.Disposable.Create(System.Action! disposer) -> System.IDisposable!

src/GitVersion.Core/VersionCalculation/TrunkBased/EnrichIncrement.cs

@@ -11,7 +11,9 @@ public void Enrich(TrunkBasedIteration iteration, TrunkBasedCommit commit, Trunk
     {
         var effectiveConfiguration = commit.GetEffectiveConfiguration(context.Configuration);
         var incrementForcedByBranch = effectiveConfiguration.Increment.ToVersionField();
-        var incrementForcedByCommit = GetIncrementForcedByCommit(context, commit.Value, effectiveConfiguration);
+        var incrementForcedByCommit = commit.IsDummy
+            ? VersionField.None
+            : GetIncrementForcedByCommit(context, commit.Value, effectiveConfiguration);
         commit.Increment = incrementForcedByCommit;
         context.Increment = context.Increment.Consolidate(incrementForcedByBranch, incrementForcedByCommit);
 

src/GitVersion.Core/VersionCalculation/TrunkBased/NonTrunk/FirstCommitOnRelease.cs

@@ -24,7 +24,7 @@ public bool MatchPrecondition(TrunkBasedIteration iteration, TrunkBasedCommit co
            && commit.GetEffectiveConfiguration(context.Configuration).IsReleaseBranch
            && context.SemanticVersion is null
            && (commit.Predecessor is null
-               || commit.Predecessor?.BranchName != commit.BranchName);
+               || commit.BranchName != commit.Predecessor?.BranchName);
 
     public IEnumerable<IBaseVersionIncrement> GetIncrements(
         TrunkBasedIteration iteration, TrunkBasedCommit commit, TrunkBasedContext context)

src/GitVersion.Core/VersionCalculation/TrunkBased/TrunkBasedCommit.cs

@@ -10,7 +10,7 @@ namespace GitVersion.VersionCalculation.TrunkBased;
     "HasSuccessor = {" + nameof(HasSuccessor) + "}, HasPredecessor = {" + nameof(HasPredecessor) + "}, " +
     "HasChildIteration = {" + nameof(HasChildIteration) + "}, Message = {" + nameof(Message) + @"} \}"
 )]
-internal record TrunkBasedCommit(TrunkBasedIteration Iteration, ICommit Value, ReferenceName BranchName, IBranchConfiguration Configuration)
+internal record TrunkBasedCommit(TrunkBasedIteration Iteration, ICommit? value, ReferenceName BranchName, IBranchConfiguration Configuration)
 {
     public bool IsPredecessorTheLastCommitOnTrunk(IGitVersionConfiguration configuration)
         => !GetEffectiveConfiguration(configuration).IsMainBranch && Predecessor?.GetEffectiveConfiguration(configuration).IsMainBranch == true;
@@ -31,9 +31,12 @@ public bool IsPredecessorTheLastCommitOnTrunk(IGitVersionConfiguration configura
 
     public TrunkBasedCommit? Predecessor { get; private set; }
 
-    public ICommit Value { get; } = Value.NotNull();
+    public ICommit Value => IsDummy ? (Successor?.Value)! : value!;
 
-    public string Message => Value.Message;
+    [MemberNotNullWhen(false, nameof(Value))]
+    public bool IsDummy => value is null;
+
+    public string Message => IsDummy ? "<<DUMMY>>" : Value.Message;
 
     public TrunkBasedIteration? ChildIteration { get; private set; }
 
@@ -101,7 +104,7 @@ public void AddSemanticVersions(IEnumerable<SemanticVersion> values)
     public void AddChildIteration(TrunkBasedIteration iteration) => ChildIteration = iteration.NotNull();
 
     public TrunkBasedCommit Append(
-        ICommit value, ReferenceName branchName, IBranchConfiguration configuration)
+        ICommit? value, ReferenceName branchName, IBranchConfiguration configuration)
     {
         if (HasPredecessor) throw new InvalidOperationException();
 

src/GitVersion.Core/VersionCalculation/TrunkBased/TrunkBasedIteration.cs

@@ -63,17 +63,21 @@ public TrunkBasedIteration(string id, ReferenceName branchName, IBranchConfigura
     }
 
     public TrunkBasedCommit CreateCommit(
-        ICommit value, ReferenceName branchName, IBranchConfiguration configuration)
+        ICommit? value, ReferenceName branchName, IBranchConfiguration configuration)
     {
         TrunkBasedCommit commit;
         if (commits.Count != 0)
-            commit = commits.Peek().Append(value, branchName, configuration); //, increment);
+            commit = commits.Peek().Append(value, branchName, configuration);
         else
         {
-            commit = new TrunkBasedCommit(this, value, branchName, configuration); //, increment);
+            commit = new TrunkBasedCommit(this, value, branchName, configuration);
         }
         commits.Push(commit);
-        commitLookup.Add(value, commit);
+
+        if (value is not null)
+        {
+            commitLookup.Add(value, commit);
+        }
 
         return commit;
     }