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

Author: HHobeck

src/GitVersion.Configuration.Tests/Configuration/ConfigurationProviderTests.CanWriteOutEffectiveConfiguration.approved.txt

@@ -25,8 +25,10 @@ branches:
     prevent-increment:
       when-current-commit-tagged: false
     track-merge-target: true
+    track-merge-message: true
     regex: ^dev(elop)?(ment)?$
-    source-branches: []
+    source-branches:
+    - main
     is-source-branch-for: []
     tracks-release-branches: true
     is-release-branch: false
@@ -38,10 +40,9 @@ branches:
     prevent-increment:
       of-merged-branch: true
     track-merge-target: false
+    track-merge-message: true
     regex: ^master$|^main$
-    source-branches:
-    - develop
-    - release
+    source-branches: []
     is-source-branch-for: []
     tracks-release-branches: false
     is-release-branch: false
@@ -50,17 +51,15 @@ branches:
   release:
     mode: ManualDeployment
     label: beta
-    increment: None
+    increment: Minor
     prevent-increment:
       of-merged-branch: true
       when-current-commit-tagged: false
     track-merge-target: false
     regex: ^releases?[/-](?<BranchName>.+)
     source-branches:
-    - develop
     - main
     - support
-    - release
     is-source-branch-for: []
     tracks-release-branches: false
     is-release-branch: true
@@ -70,23 +69,28 @@ branches:
     mode: ManualDeployment
     label: '{BranchName}'
     increment: Inherit
-    prevent-increment: {}
+    prevent-increment:
+      when-current-commit-tagged: false
+    track-merge-message: true
     regex: ^features?[/-](?<BranchName>.+)
     source-branches:
     - develop
     - main
     - release
-    - feature
     - support
     - hotfix
     is-source-branch-for: []
+    is-main-branch: false
     pre-release-weight: 30000
   pull-request:
     mode: ContinuousDelivery
     label: PullRequest
     increment: Inherit
-    prevent-increment: {}
+    prevent-increment:
+      of-merged-branch: true
+      when-current-commit-tagged: false
     label-number-pattern: '[/-](?<number>\d+)'
+    track-merge-message: true
     regex: ^(pull|pull\-requests|pr)[/-]
     source-branches:
     - develop
@@ -105,12 +109,11 @@ branches:
       when-current-commit-tagged: false
     regex: ^hotfix(es)?[/-](?<BranchName>.+)
     source-branches:
-    - release
     - main
     - support
-    - hotfix
     is-source-branch-for: []
     is-release-branch: true
+    is-main-branch: false
     pre-release-weight: 30000
   support:
     label: ''
@@ -130,7 +133,8 @@ branches:
     mode: ManualDeployment
     label: '{BranchName}'
     increment: Inherit
-    prevent-increment: {}
+    prevent-increment:
+      when-current-commit-tagged: true
     regex: (?<BranchName>.+)
     source-branches:
     - main
@@ -141,6 +145,7 @@ branches:
     - hotfix
     - support
     is-source-branch-for: []
+    is-main-branch: false
 ignore:
   sha: []
 mode: ContinuousDelivery

src/GitVersion.Configuration.Tests/Configuration/ConfigurationProviderTests.cs

@@ -316,7 +316,7 @@ public void ShouldUseDefaultSourceBranchesWhenNotSpecifiedForDevelop()
         using var _ = this.fileSystem.SetupConfigFile(path: this.repoPath, text: text);
         var configuration = this.configurationProvider.ProvideForDirectory(this.repoPath);
 
-        configuration.Branches["develop"].SourceBranches.ShouldBe(new List<string>());
+        configuration.Branches["develop"].SourceBranches.ShouldBe(["main"]);
     }
 
     [Test]
@@ -348,7 +348,7 @@ public void ShouldUseDefaultSourceBranchesWhenNotSpecifiedForFeature()
         var configuration = this.configurationProvider.ProvideForDirectory(this.repoPath);
 
         configuration.Branches["feature"].SourceBranches.ShouldBe(
-            new List<string> { "develop", MainBranch, "release", "feature", "support", "hotfix" });
+            ["develop", MainBranch, "release", "support", "hotfix"]);
     }
 
     [Test]

src/GitVersion.Configuration/BranchConfiguration.cs

@@ -107,4 +107,31 @@ public virtual IBranchConfiguration Inherit(IBranchConfiguration configuration)
             PreReleaseWeight = PreReleaseWeight ?? configuration.PreReleaseWeight
         };
     }
+
+    public virtual IBranchConfiguration Inherit(EffectiveConfiguration configuration)
+    {
+        configuration.NotNull();
+
+        return new BranchConfiguration(this)
+        {
+            Increment = Increment == IncrementStrategy.Inherit ? configuration.Increment : Increment,
+            DeploymentMode = DeploymentMode ?? configuration.DeploymentMode,
+            Label = Label ?? configuration.Label,
+            PreventIncrement = new PreventIncrementConfiguration()
+            {
+                OfMergedBranch = PreventIncrement.OfMergedBranch ?? configuration.PreventIncrementOfMergedBranch,
+                WhenBranchMerged = PreventIncrement.WhenBranchMerged ?? configuration.PreventIncrementWhenBranchMerged,
+                WhenCurrentCommitTagged = PreventIncrement.WhenCurrentCommitTagged ?? configuration.PreventIncrementWhenCurrentCommitTagged
+            },
+            LabelNumberPattern = LabelNumberPattern ?? configuration.LabelNumberPattern,
+            TrackMergeTarget = TrackMergeTarget ?? configuration.TrackMergeTarget,
+            TrackMergeMessage = TrackMergeMessage ?? configuration.TrackMergeMessage,
+            CommitMessageIncrementing = CommitMessageIncrementing ?? configuration.CommitMessageIncrementing,
+            RegularExpression = RegularExpression ?? configuration.RegularExpression,
+            TracksReleaseBranches = TracksReleaseBranches ?? configuration.TracksReleaseBranches,
+            IsReleaseBranch = IsReleaseBranch ?? configuration.IsReleaseBranch,
+            IsMainBranch = IsMainBranch ?? configuration.IsMainBranch,
+            PreReleaseWeight = PreReleaseWeight ?? configuration.PreReleaseWeight
+        };
+    }
 }

src/GitVersion.Configuration/Builders/GitFlowConfigurationBuilder.cs

@@ -45,13 +45,14 @@ private GitFlowConfigurationBuilder()
         {
             Increment = IncrementStrategy.Minor,
             RegularExpression = DevelopBranch.RegexPattern,
-            SourceBranches = [],
+            SourceBranches = [this.MainBranch.Name],
             Label = "alpha",
             PreventIncrement = new PreventIncrementConfiguration()
             {
                 WhenCurrentCommitTagged = false
             },
             TrackMergeTarget = true,
+            TrackMergeMessage = true,
             TracksReleaseBranches = true,
             IsMainBranch = false,
             IsReleaseBranch = false,
@@ -62,17 +63,14 @@ private GitFlowConfigurationBuilder()
         {
             Increment = IncrementStrategy.Patch,
             RegularExpression = MainBranch.RegexPattern,
-            SourceBranches =
-            [
-                this.DevelopBranch.Name,
-                this.ReleaseBranch.Name
-            ],
+            SourceBranches = [],
             Label = string.Empty,
             PreventIncrement = new PreventIncrementConfiguration()
             {
                 OfMergedBranch = true
             },
             TrackMergeTarget = false,
+            TrackMergeMessage = true,
             TracksReleaseBranches = false,
             IsMainBranch = true,
             IsReleaseBranch = false,
@@ -81,15 +79,13 @@ private GitFlowConfigurationBuilder()
 
         WithBranch(ReleaseBranch.Name).WithConfiguration(new BranchConfiguration
         {
-            Increment = IncrementStrategy.None,
+            Increment = IncrementStrategy.Minor,
             DeploymentMode = DeploymentMode.ManualDeployment,
             RegularExpression = ReleaseBranch.RegexPattern,
             SourceBranches =
             [
-                this.DevelopBranch.Name,
                 this.MainBranch.Name,
                 this.SupportBranch.Name,
-                this.ReleaseBranch.Name
             ],
             Label = "beta",
             PreventIncrement = new PreventIncrementConfiguration()
@@ -114,11 +110,16 @@ private GitFlowConfigurationBuilder()
                 this.DevelopBranch.Name,
                 this.MainBranch.Name,
                 this.ReleaseBranch.Name,
-                this.FeatureBranch.Name,
                 this.SupportBranch.Name,
                 this.HotfixBranch.Name
             ],
             Label = ConfigurationConstants.BranchNamePlaceholder,
+            PreventIncrement = new PreventIncrementConfiguration()
+            {
+                WhenCurrentCommitTagged = false
+            },
+            TrackMergeMessage = true,
+            IsMainBranch = false,
             PreReleaseWeight = 30000
         });
 
@@ -137,7 +138,13 @@ private GitFlowConfigurationBuilder()
                 this.HotfixBranch.Name
             ],
             Label = "PullRequest",
+            PreventIncrement = new PreventIncrementConfiguration()
+            {
+                OfMergedBranch = true,
+                WhenCurrentCommitTagged = false
+            },
             LabelNumberPattern = ConfigurationConstants.DefaultLabelNumberPattern,
+            TrackMergeMessage = true,
             PreReleaseWeight = 30000
         });
 
@@ -152,13 +159,12 @@ private GitFlowConfigurationBuilder()
             },
             SourceBranches =
             [
-                this.ReleaseBranch.Name,
                 this.MainBranch.Name,
                 this.SupportBranch.Name,
-                this.HotfixBranch.Name
             ],
             Label = "beta",
             IsReleaseBranch = true,
+            IsMainBranch = false,
             PreReleaseWeight = 30000
         });
 
@@ -182,7 +188,6 @@ private GitFlowConfigurationBuilder()
         WithBranch(UnknownBranch.Name).WithConfiguration(new BranchConfiguration
         {
             RegularExpression = UnknownBranch.RegexPattern,
-            Label = ConfigurationConstants.BranchNamePlaceholder,
             DeploymentMode = DeploymentMode.ManualDeployment,
             Increment = IncrementStrategy.Inherit,
             SourceBranches =
@@ -194,7 +199,13 @@ private GitFlowConfigurationBuilder()
                 this.PullRequestBranch.Name,
                 this.HotfixBranch.Name,
                 this.SupportBranch.Name
-            ]
+            ],
+            Label = ConfigurationConstants.BranchNamePlaceholder,
+            PreventIncrement = new PreventIncrementConfiguration()
+            {
+                WhenCurrentCommitTagged = true
+            },
+            IsMainBranch = false,
         });
     }
 }