Bump develop when release branch is created

 - Fixed an commit counting bug
 - Based on discussion at #632
 - Fixes #695
 - Updated related docs

Author: JakeGinnivan

docs/configuration.md

@@ -46,6 +46,10 @@ The global configuration options are:
    - **`sha:`** A sequence of SHAs to be excluded from the version calculations.  Useful when there is a rogue commit in history yielding a bad version.
    - **`commits-before:`** Allows to setup an exclusion range.  Effectively any commit < `commits-before` will be ignored.
 
+ - **`is-develop:`** Indicates this branch config represents develop in GitFlow
+
+ **`is-release-branch:`** Indicates this branch config represents a release branch in GitFlow
+
 ## Branch configuration
 
 Then we have branch specific configuration, which looks something like this:

docs/git-branching-strategies/img/39f9d8b8b007c82f1f80_major-release.png

@@ -16,42 +16,56 @@ branches:
     increment: Patch
     prevent-increment-of-merged-branch-version: true
     track-merge-target: false
+    is-develop: false
+    is-release-branch: false
   releases?[/-]:
     mode: ContinuousDelivery
     tag: beta
     increment: Patch
     prevent-increment-of-merged-branch-version: true
     track-merge-target: false
+    is-develop: false
+    is-release-branch: true
   features?[/-]:
     mode: ContinuousDelivery
     tag: useBranchName
     increment: Inherit
     prevent-increment-of-merged-branch-version: false
     track-merge-target: false
+    is-develop: false
+    is-release-branch: false
   (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
+    is-develop: false
+    is-release-branch: false
   hotfix(es)?[/-]:
     mode: ContinuousDelivery
     tag: beta
     increment: Patch
     prevent-increment-of-merged-branch-version: false
     track-merge-target: false
+    is-develop: false
+    is-release-branch: false
   support[/-]:
     mode: ContinuousDelivery
     tag: ''
     increment: Patch
     prevent-increment-of-merged-branch-version: true
     track-merge-target: false
+    is-develop: false
+    is-release-branch: false
   dev(elop)?(ment)?$:
     mode: ContinuousDeployment
     tag: unstable
     increment: Minor
     prevent-increment-of-merged-branch-version: false
     track-merge-target: true
+    is-develop: true
+    is-release-branch: false
 ignore:
   sha: []

docs/git-branching-strategies/img/6d33d35a70a777608fa1_minor-release.png

@@ -112,7 +112,7 @@ public void CanProvideConfigForNewBranch()
         tag: bugfix";
         SetupConfigFileContent(text);
         var config = ConfigurationProvider.Provide(repoPath, fileSystem);
-        
+
         config.Branches["bug[/-]"].Tag.ShouldBe("bugfix");
     }
 
@@ -145,7 +145,7 @@ public void NextVersionCanHavePatch()
 
         config.NextVersion.ShouldBe("2.12.654651698");
     }
-    
+
     [Test]
     [Category("NoMono")]
     [Description("Won't run on Mono due to source information not being available for ShouldMatchApproved.")]
@@ -235,10 +235,10 @@ public void WarnOnExistingGitVersionConfigYamlFile()
 
         var s = string.Empty;
         Action<string> action = info => { s = info; };
-        Logger.SetLoggers(action, action, action);
-
-        ConfigurationProvider.Provide(repoPath, fileSystem);
-
+        using (Logger.AddLoggersTemporarily(action, action, action))
+        {
+            ConfigurationProvider.Provide(repoPath, fileSystem);
+        }
         s.Contains("'GitVersionConfig.yaml' is deprecated, use 'GitVersion.yml' instead.").ShouldBe(true);
     }
 
@@ -249,10 +249,10 @@ public void NoWarnOnGitVersionYmlFile()
 
         var s = string.Empty;
         Action<string> action = info => { s = info; };
-        Logger.SetLoggers(action, action, action);
-
-        ConfigurationProvider.Provide(repoPath, fileSystem);
-
+        using (Logger.AddLoggersTemporarily(action, action, action))
+        {
+            ConfigurationProvider.Provide(repoPath, fileSystem);
+        }
         s.Length.ShouldBe(0);
     }
 

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

@@ -147,12 +147,10 @@ string RepositoryScope(ExecuteCore executeCore = null, Action<EmptyRepositoryFix
         Action<string> infoLogger = s =>
         {
             infoBuilder.AppendLine(s);
-            Console.WriteLine(s);
         };
         executeCore = executeCore ?? new ExecuteCore(fileSystem);
 
-        Logger.SetLoggers(infoLogger, Console.WriteLine, Console.WriteLine);
-
+        using (Logger.AddLoggersTemporarily(infoLogger, s => {}, s => { }))
         using (var fixture = new EmptyRepositoryFixture())
         {
             fixture.Repository.MakeACommit();

src/GitVersionCore.Tests/ConfigProviderTests.cs

@@ -70,7 +70,7 @@ static SemanticVersion ExecuteGitVersion(GitVersionContext context)
         /// </summary>
         public static void InitialiseRepo(this RemoteRepositoryFixture fixture)
         {
-            // TODO !!new GitPreparer(null, null, new Authentication(), false, fixture.LocalRepositoryFixture.RepositoryPath).Initialise(true, null);
+            new GitPreparer(null, null, new Authentication(), false, fixture.LocalRepositoryFixture.RepositoryPath).Initialise(true, null);
         }
     }
 }

src/GitVersionCore.Tests/ExecuteCoreTests.cs

@@ -61,10 +61,11 @@ public void CanChangeDevelopTagViaConfig()
         {
             Branches =
             {
-                {"dev(elop)?(ment)?$", new BranchConfig
                 {
-                    Tag = "alpha"
-                }
+                    "dev(elop)?(ment)?$", new BranchConfig
+                    {
+                        Tag = "alpha"
+                    }
                 }
             }
         };
@@ -116,7 +117,7 @@ public void MergingReleaseBranchBackIntoDevelopWithMergingToMaster_DoesBumpDevel
 
             fixture.Repository.Checkout("develop");
             fixture.Repository.MergeNoFF("release-2.0.0", Generate.SignatureNow());
-            fixture.AssertFullSemver("2.1.0-unstable.0");
+            fixture.AssertFullSemver("2.1.0-unstable.2");
         }
     }
 
@@ -157,4 +158,27 @@ public void WhenDevelopBranchedFromMasterDetachedHead_MinorIsIncreased()
             fixture.AssertFullSemver("1.1.0-unstable.1");
         }
     }
+
+    [Test]
+    public void InheritVersionFromReleaseBranch()
+    {
+        using (var fixture = new EmptyRepositoryFixture())
+        {
+            fixture.MakeATaggedCommit("1.0.0");
+            fixture.BranchTo("develop");
+            fixture.MakeACommit();
+            fixture.BranchTo("release/2.0.0");
+            fixture.MakeACommit();
+            fixture.MakeACommit();
+            fixture.Checkout("develop");
+            fixture.AssertFullSemver("2.1.0-unstable.0");
+            fixture.MakeACommit();
+            fixture.AssertFullSemver("2.1.0-unstable.1");
+            fixture.MergeNoFF("release/2.0.0");
+            fixture.AssertFullSemver("2.1.0-unstable.4");
+            fixture.BranchTo("feature/MyFeature");
+            fixture.MakeACommit();
+            fixture.AssertFullSemver("2.1.0-MyFeature.1+1");
+        }
+    }
 }

src/GitVersionCore.Tests/GitToolsTestingExtensions.cs

@@ -130,7 +130,7 @@ public void GitFlowMinorRelease()
             // Make another commit on develop
             fixture.Checkout("develop");
             fixture.MakeACommit();
-            fixture.AssertFullSemver("1.3.0-unstable.2");
+            fixture.AssertFullSemver("1.4.0-unstable.1");
 
             // Make a commit to release-1.3.0
             fixture.Checkout("release/1.3.0");
@@ -159,7 +159,7 @@ public void GitFlowMinorRelease()
 
             // Not 0 for commit count as we can't know the increment rules of the merged branch
             fixture.Checkout("develop");
-            fixture.AssertFullSemver("1.4.0-unstable.2");
+            fixture.AssertFullSemver("1.4.0-unstable.4");
         }
     }
 
@@ -186,7 +186,7 @@ public void GitFlowMajorRelease()
             // Make another commit on develop
             fixture.Checkout("develop");
             fixture.MakeACommit();
-            fixture.AssertFullSemver("1.4.0-unstable.2");
+            fixture.AssertFullSemver("2.1.0-unstable.1");
 
             // Make a commit to release-2.0.0
             fixture.Checkout("release/2.0.0");
@@ -216,7 +216,7 @@ public void GitFlowMajorRelease()
 
             // Not 0 for commit count as we can't know the increment rules of the merged branch
             fixture.Checkout("develop");
-            fixture.AssertFullSemver("2.1.0-unstable.2");
+            fixture.AssertFullSemver("2.1.0-unstable.4");
         }
     }
 

src/GitVersionCore.Tests/IntegrationTests/DevelopScenarios.cs

@@ -48,7 +48,7 @@ public void NoMergeBacksToDevelopInCaseThereAreChangesInReleaseBranch()
             // Merge to develop
             fixture.Repository.Checkout("develop");
             fixture.Repository.MergeNoFF("release/1.0.0");
-            fixture.AssertFullSemver("1.1.0-unstable.1");
+            fixture.AssertFullSemver("1.1.0-unstable.2");
 
             fixture.Repository.MakeACommit();
             fixture.Repository.Branches.Remove(releaseBranch);
@@ -226,7 +226,7 @@ public void WhenReleaseBranchIsMergedIntoDevelopHighestVersionIsTakenWithIt()
             fixture.Repository.Checkout("develop");
             fixture.Repository.MergeNoFF("release-1.0.0", Generate.SignatureNow());
 
-            fixture.AssertFullSemver("2.1.0-unstable.5");
+            fixture.AssertFullSemver("2.1.0-unstable.6");
         }
     }
 

src/GitVersionCore.Tests/IntegrationTests/DocumentationSamples.cs

@@ -1,6 +1,8 @@
 using NUnit.Framework;
 using System;
 using GitVersion;
+using Shouldly;
+
 namespace GitVersionCore.Tests
 {
     [TestFixture]
@@ -15,25 +17,22 @@ public void LoggerObscuresPassword(string protocol)
             const string password = "password";
             var s = string.Empty;
             Action<string> action = info => { s = info; };
-            Logger.SetLoggers(action, action, action);
-
-            Logger.WriteInfo(string.Format("{0}://{1}:{2}@workspace.visualstudio.com/DefaultCollection/_git/CAS",protocol,username,password));
+            using (Logger.AddLoggersTemporarily(action, action, action))
+                Logger.WriteInfo(string.Format("{0}://{1}:{2}@workspace.visualstudio.com/DefaultCollection/_git/CAS",protocol,username,password));
 
-            Assert.IsFalse(s.Contains(password));
+            s.Contains(password).ShouldBe(false);
         }
 
         [Test]
         public void UsernameWithoutPassword()
         {
             var s = string.Empty;
             Action<string> action = info => { s = info; };
-            Logger.SetLoggers(action, action, action);
-
             const string repoUrl = "http://[email protected]/DefaultCollection/_git/CAS";
-            Logger.WriteInfo(repoUrl);
+            using (Logger.AddLoggersTemporarily(action, action, action))
+                Logger.WriteInfo(repoUrl);
 
-            Assert.IsTrue(s.Contains(repoUrl));
+            s.Contains(repoUrl).ShouldBe(true);
         }
-
     }
 }

src/GitVersionCore.Tests/IntegrationTests/ReleaseBranchScenarios.cs

@@ -1,5 +1,5 @@
-using System.Diagnostics;
-using GitVersion;
+using GitVersion;
+using System;
 
 /// <summary>
 /// Used by the ModuleInit. All code inside the Initialize method is ran as soon as the assembly is loaded.
@@ -11,6 +11,9 @@ public static class ModuleInitializer
     /// </summary>
     public static void Initialize()
     {
-        Logger.SetLoggers(s => Trace.WriteLine(s), s => Trace.WriteLine(s), s => Trace.WriteLine(s));
+        Logger.SetLoggers(
+            s => Console.WriteLine(s),
+            s => Console.WriteLine(s),
+            s => Console.WriteLine(s));
     }
 }

src/GitVersionCore.Tests/LoggerTest.cs

@@ -26,14 +26,16 @@ public TestEffectiveConfiguration(
             int legacySemVerPadding = 4,
             int buildMetaDataPadding = 4,
             int commitsSinceVersionSourcePadding = 4,
-            IEnumerable<IVersionFilter> versionFilters = null
-            ) :
+            IEnumerable<IVersionFilter> versionFilters = null,
+            bool isDevelop = false,
+            bool isRelease = false) : 
             base(assemblyVersioningScheme, assemblyInformationalFormat, versioningMode, gitTagPrefix, tag, nextVersion, IncrementStrategy.Patch,
                     branchPrefixToTrim, preventIncrementForMergedBranchVersion, tagNumberPattern, continuousDeploymentFallbackTag,
                     trackMergeTarget,
                     majorMessage, minorMessage, patchMessage,
                     commitMessageMode, legacySemVerPadding, buildMetaDataPadding, commitsSinceVersionSourcePadding,
-                    versionFilters ?? Enumerable.Empty<IVersionFilter>())
+                    versionFilters ?? Enumerable.Empty<IVersionFilter>(),
+                    isDevelop, isRelease)
         {
         }
     }

src/GitVersionCore.Tests/ModuleInitializer.cs

@@ -2,7 +2,6 @@
 using GitVersion;
 using GitVersion.VersionCalculation.BaseVersionCalculators;
 using GitVersion.VersionFilters;
-using LibGit2Sharp;
 using NUnit.Framework;
 using Shouldly;
 
@@ -14,7 +13,6 @@ public class MinDateVersionFilterTests
         [Test]
         public void VerifyNullGuard()
         {
-            var commit = new MockCommit();
             var dummy = DateTimeOffset.UtcNow.AddSeconds(1.0);
             var sut = new MinDateVersionFilter(dummy);
 
@@ -51,8 +49,7 @@ public void WhenShaMismatchShouldNotExclude()
         [Test]
         public void ExcludeShouldAcceptVersionWithNullCommit()
         {
-            Commit nullCommit = null;
-            var version = new BaseVersion("dummy", false, new SemanticVersion(1), nullCommit, string.Empty);
+            var version = new BaseVersion("dummy", false, new SemanticVersion(1), null, string.Empty);
             var futureDate = DateTimeOffset.UtcNow.AddYears(1);
             var sut = new MinDateVersionFilter(futureDate);
 

src/GitVersionCore.Tests/TestEffectiveConfiguration.cs

@@ -2,7 +2,6 @@
 using GitVersion;
 using GitVersion.VersionCalculation.BaseVersionCalculators;
 using GitVersion.VersionFilters;
-using LibGit2Sharp;
 using NUnit.Framework;
 using Shouldly;
 
@@ -54,8 +53,7 @@ public void WhenShaMismatchShouldNotExclude()
         [Test]
         public void ExcludeShouldAcceptVersionWithNullCommit()
         {
-            Commit nullCommit = null;
-            var version = new BaseVersion("dummy", false, new SemanticVersion(1), nullCommit, string.Empty);
+            var version = new BaseVersion("dummy", false, new SemanticVersion(1), null, string.Empty);
             var sut = new ShaVersionFilter(new[] { "mismatched" });
 
             string reason;

src/GitVersionCore.Tests/VersionFilters/MinDateVersionFilterTests.cs

@@ -17,6 +17,8 @@ public BranchConfig(BranchConfig branchConfiguration)
             TagNumberPattern = branchConfiguration.TagNumberPattern;
             TrackMergeTarget = branchConfiguration.TrackMergeTarget;
             CommitMessageIncrementing = branchConfiguration.CommitMessageIncrementing;
+            IsDevelop = branchConfiguration.IsDevelop;
+            IsReleaseBranch = branchConfiguration.IsReleaseBranch;
         }
 
         [YamlMember(Alias = "mode")]
@@ -42,5 +44,11 @@ public BranchConfig(BranchConfig branchConfiguration)
 
         [YamlMember(Alias = "commit-message-incrementing")]
         public CommitMessageIncrementMode? CommitMessageIncrementing { get; set; }
+
+        [YamlMember(Alias = "is-develop")]
+        public bool? IsDevelop { get; set; }
+
+        [YamlMember(Alias = "is-release-branch")]
+        public bool? IsReleaseBranch { get; set; }
     }
 }