Merge pull request #3190 from HHobeck/feature/3101

Change the logic inheriting BranchConfiguration from parent branch if the IncrementStrategy is set to Inherit

Author: asbjornu

BREAKING_CHANGES.md

@@ -1,6 +1,17 @@
 ## Unreleased
 
 *   When using a commit message that matches **both** `*-version-bump-message` and `no-bump-message`, there is no increment for that commit. In other words, `no-bump-message` now takes precedence over `*-version-bump-message`.
+*   The fallback version strategy now returns `0.0.0` and is flagged with `ShouldIncrement` equal to `true`. This yields the version `0.1.0` on the `develop` branch (`IncrementStrategy.Minor` by default) and `0.0.1` on the `main` branch (`IncremetnStrategy.Patch` by default).
+*   The current branch (child) inherits its configuration from the source (parent) branch if the `increment` strategy is set to `Inherit`. This makes branch configuration recursive, simpler, more intuitive, more flexible, and more robust.
+*   Instead of having a single effective configuration, we now have one effective configuration per branch where the increment strategy is not set to `inherit`.
+*   The new implementation of the branch configuration inheritance affects per default only the pull-requests, hotfix and feature branches. In this case the next version will be generated like the child branch is not existing and the commits have been made on the source branch.
+    *   The following example illustrates this behavior. On the feature branch the semantic version `1.1.0-just-a-test.1+2` will now be generated instead of version `1.0.0-just-a-test.1+3` previously:
+	```
+    * 1f1cfb4 52 minutes ago  (HEAD -> feature/just-a-test)
+	* 1f9654d 54 minutes ago  (release/1.1.0)
+	* be72411 56 minutes ago  (develop)
+	* 14800ff 58 minutes ago  (tag: 1.0.0, main)
+	```
 
 ## v5.0.0
 

docs/input/docs/learn/how-it-works.md

@@ -47,7 +47,9 @@ Currently we have the following strategies:
     GitVersion.yaml file
 *   `MergeMessageBaseVersionStrategy` - Finds version numbers from merge messages
     (e.g., `Merge 'release/3.0.0' into 'main'` will return `3.0.0`)
-*   `FallbackBaseVersionStrategy` - Always returns 0.1.0 for new repositories
+*   `FallbackBaseVersionStrategy` - Always returns 0.0.0 and will be used for
+    calculating the next version which is dependent on the increment strategy of 
+	the effected branch (e.g. on main the next version is 0.0.1 or on develop it is 0.1.0)
 
 Each strategy needs to return an instance of `BaseVersion` which has the
 following properties:

docs/input/docs/reference/configuration.md

@@ -329,39 +329,24 @@ branches:
   feature:
     regex: ^features?[/-]
     mode: ContinuousDelivery
-    tag: useBranchName
+    tag: '{BranchName}'
     increment: Inherit
-    prevent-increment-of-merged-branch-version: false
-    track-merge-target: false
     source-branches: [ 'develop', 'main', 'release', 'feature', 'support', 'hotfix' ]
-    tracks-release-branches: false
-    is-release-branch: false
-    is-mainline: false
-    pre-release-weight: 30000
+    pre-release-weight: 30000	
   pull-request:
     regex: ^(pull|pull\-requests|pr)[/-]
     mode: ContinuousDelivery
     tag: PullRequest
     increment: Inherit
-    prevent-increment-of-merged-branch-version: false
     tag-number-pattern: '[/-](?<number>\d+)[-/]'
-    track-merge-target: false
     source-branches: [ 'develop', 'main', 'release', 'feature', 'support', 'hotfix' ]
-    tracks-release-branches: false
-    is-release-branch: false
-    is-mainline: false
     pre-release-weight: 30000
   hotfix:
     regex: ^hotfix(es)?[/-]
     mode: ContinuousDelivery
     tag: beta
-    increment: Patch
-    prevent-increment-of-merged-branch-version: false
-    track-merge-target: false
-    source-branches: [ 'develop', 'main', 'support' ]
-    tracks-release-branches: false
-    is-release-branch: false
-    is-mainline: false
+    increment: Inherit
+    source-branches: [ 'release', 'main', 'support', 'hotfix' ]
     pre-release-weight: 30000
   support:
     regex: ^support[/-]

src/GitVersion.App.Tests/JsonOutputOnBuildServerTest.cs

@@ -37,10 +37,10 @@ public void BeingOnBuildServerWithOutputJsonDoesNotFail()
         var result = GitVersionHelper.ExecuteIn(fixture.LocalRepositoryFixture.RepositoryPath, arguments: " /output json /output buildserver", environments: env);
 
         result.ExitCode.ShouldBe(0);
-        const string version = "0.1.0+4";
-        result.Output.ShouldContain($"##teamcity[buildNumber '{version}']");
+        const string expectedVersion = "0.0.1+5";
+        result.Output.ShouldContain($"##teamcity[buildNumber '{expectedVersion}']");
         result.OutputVariables.ShouldNotBeNull();
-        result.OutputVariables.FullSemVer.ShouldBeEquivalentTo(version);
+        result.OutputVariables.FullSemVer.ShouldBeEquivalentTo(expectedVersion);
     }
 
     [TestCase("", "GitVersion.json")]
@@ -56,16 +56,16 @@ public void BeingOnBuildServerWithOutputJsonAndOutputFileDoesNotFail(string outp
         var result = GitVersionHelper.ExecuteIn(fixture.LocalRepositoryFixture.RepositoryPath, arguments: $" /output json /output buildserver /output file /outputfile {outputFile}", environments: env);
 
         result.ExitCode.ShouldBe(0);
-        const string version = "0.1.0+4";
-        result.Output.ShouldContain($"##teamcity[buildNumber '{version}']");
+        const string expectedVersion = "0.0.1+5";
+        result.Output.ShouldContain($"##teamcity[buildNumber '{expectedVersion}']");
         result.OutputVariables.ShouldNotBeNull();
-        result.OutputVariables.FullSemVer.ShouldBeEquivalentTo(version);
+        result.OutputVariables.FullSemVer.ShouldBeEquivalentTo(expectedVersion);
 
         var filePath = PathHelper.Combine(fixture.LocalRepositoryFixture.RepositoryPath, fileName);
         var json = File.ReadAllText(filePath);
 
         var outputVariables = VersionVariables.FromJson(json);
         outputVariables.ShouldNotBeNull();
-        outputVariables.FullSemVer.ShouldBeEquivalentTo(version);
+        outputVariables.FullSemVer.ShouldBeEquivalentTo(expectedVersion);
     }
 }

src/GitVersion.Core.Tests/Configuration/ConfigProviderTests.CanWriteOutEffectiveConfiguration.approved.txt

@@ -82,18 +82,13 @@ branches:
   hotfix:
     mode: ContinuousDelivery
     tag: beta
-    increment: Patch
-    prevent-increment-of-merged-branch-version: false
-    track-merge-target: false
+    increment: Inherit
     regex: ^hotfix(es)?[/-]
     source-branches:
     - release
     - main
     - support
     - hotfix
-    tracks-release-branches: false
-    is-release-branch: false
-    is-mainline: false
     pre-release-weight: 30000
   support:
     mode: ContinuousDelivery

src/GitVersion.Core.Tests/Core/GitVersionExecutorTests.cs

@@ -150,7 +150,7 @@ public void CacheFileExistsOnDisk()
         var gitVersionCalculator = GetGitVersionCalculator(gitVersionOptions, this.log);
 
         var versionVariables = gitVersionCalculator.CalculateVersionVariables();
-        versionVariables.AssemblySemVer.ShouldBe("0.1.0.0");
+        versionVariables.AssemblySemVer.ShouldBe("0.0.1.0");
 
         this.fileSystem.WriteAllText(versionVariables.FileName, versionCacheFileContent);
         versionVariables = gitVersionCalculator.CalculateVersionVariables();
@@ -197,7 +197,7 @@ public void CacheFileExistsOnDiskWhenOverrideConfigIsSpecifiedVersionShouldBeDyn
         var gitVersionCalculator = GetGitVersionCalculator(gitVersionOptions, this.log);
 
         var versionVariables = gitVersionCalculator.CalculateVersionVariables();
-        versionVariables.AssemblySemVer.ShouldBe("0.1.0.0");
+        versionVariables.AssemblySemVer.ShouldBe("0.0.1.0");
 
         this.fileSystem.WriteAllText(versionVariables.FileName, versionCacheFileContent);
 
@@ -211,7 +211,7 @@ public void CacheFileExistsOnDiskWhenOverrideConfigIsSpecifiedVersionShouldBeDyn
         gitVersionCalculator = GetGitVersionCalculator(gitVersionOptions);
         versionVariables = gitVersionCalculator.CalculateVersionVariables();
 
-        versionVariables.AssemblySemVer.ShouldBe("0.1.0.0");
+        versionVariables.AssemblySemVer.ShouldBe("0.0.1.0");
 
         var cachedDirectoryTimestampAfter = this.fileSystem.GetLastDirectoryWrite(cacheDirectory);
         cachedDirectoryTimestampAfter.ShouldBe(cacheDirectoryTimestamp, "Cache was updated when override config was set");
@@ -279,7 +279,7 @@ public void ConfigChangeInvalidatesCache()
         var gitVersionCalculator = GetGitVersionCalculator(gitVersionOptions);
         var versionVariables = gitVersionCalculator.CalculateVersionVariables();
 
-        versionVariables.AssemblySemVer.ShouldBe("0.1.0.0");
+        versionVariables.AssemblySemVer.ShouldBe("0.0.1.0");
         versionVariables.FileName.ShouldNotBeNullOrEmpty();
 
         this.fileSystem.WriteAllText(versionVariables.FileName, versionCacheFileContent);
@@ -336,7 +336,7 @@ public void NoCacheBypassesCache()
 
         var versionVariables = gitVersionCalculator.CalculateVersionVariables();
 
-        versionVariables.AssemblySemVer.ShouldBe("0.1.0.0");
+        versionVariables.AssemblySemVer.ShouldBe("0.0.1.0");
         versionVariables.FileName.ShouldNotBeNullOrEmpty();
 
         this.fileSystem.WriteAllText(versionVariables.FileName, versionCacheFileContent);
@@ -345,7 +345,7 @@ public void NoCacheBypassesCache()
 
         gitVersionOptions.Settings.NoCache = true;
         versionVariables = gitVersionCalculator.CalculateVersionVariables();
-        versionVariables.AssemblySemVer.ShouldBe("0.1.0.0");
+        versionVariables.AssemblySemVer.ShouldBe("0.0.1.0");
     }
 
     [Test]

src/GitVersion.Core.Tests/Core/RepositoryStoreTests.cs

@@ -68,7 +68,7 @@ public void FindsCorrectMergeBaseForForwardMerge()
 
         var developMergeBase = gitRepoMetadataProvider.FindMergeBase(develop, release);
 
-        fixtureRepository.DumpGraph(Console.WriteLine);
+        fixtureRepository.DumpGraph();
 
         releaseBranchMergeBase.ShouldBe(expectedReleaseMergeBase);
         developMergeBase.ShouldBe(expectedDevelopMergeBase);
@@ -124,7 +124,7 @@ public void FindsCorrectMergeBaseForForwardMergeMovesOn()
 
         var developMergeBase = gitRepoMetadataProvider.FindMergeBase(develop, release);
 
-        fixtureRepository.DumpGraph(Console.WriteLine);
+        fixtureRepository.DumpGraph();
 
         releaseBranchMergeBase.ShouldBe(expectedReleaseMergeBase);
         developMergeBase.ShouldBe(expectedDevelopMergeBase);
@@ -199,7 +199,7 @@ public void FindsCorrectMergeBaseForMultipleForwardMerges()
 
         var developMergeBase = gitRepoMetadataProvider.FindMergeBase(develop, release);
 
-        fixtureRepository.DumpGraph(Console.WriteLine);
+        fixtureRepository.DumpGraph();
 
         releaseBranchMergeBase.ShouldBe(expectedReleaseMergeBase);
         developMergeBase.ShouldBe(expectedDevelopMergeBase);

src/GitVersion.Core.Tests/Extensions/GitToolsTestingExtensions.cs

@@ -106,8 +106,6 @@ public static void WriteVersionVariables(this RepositoryFixtureBase fixture, str
 
     public static void AssertFullSemver(this RepositoryFixtureBase fixture, string fullSemver, Config? configuration = null, IRepository? repository = null, string? commitId = null, bool onlyTrackedBranches = true, string? targetBranch = null)
     {
-        configuration ??= new Config();
-        configuration = new ConfigurationBuilder().Add(configuration).Build();
         Console.WriteLine("---------");
 
         try

src/GitVersion.Core.Tests/Helpers/TestConfigurationBuilder.cs

@@ -8,7 +8,7 @@ public sealed class TestConfigurationBuilder
 {
     public static TestConfigurationBuilder New => new();
 
-    private string? nextVerson;
+    private string? nextVersion;
     private VersioningMode? versioningMode;
     private readonly Dictionary<string, VersioningMode?> versioningModeDictionary = new();
     private bool withoutAnyTrackMergeTargets;
@@ -28,7 +28,7 @@ private TestConfigurationBuilder()
 
     public TestConfigurationBuilder WithNextVersion(string? value)
     {
-        nextVerson = value;
+        nextVersion = value;
         return this;
     }
 
@@ -109,7 +109,7 @@ public Config Build()
     {
         Config configuration = new()
         {
-            NextVersion = nextVerson,
+            NextVersion = nextVersion,
             VersioningMode = versioningMode
         };