Add support for indicating change severity in commit messages

TomGillen · TomGillen · commit f3947a957a92 · 2015-08-20T11:31:46.000+01:00
While active, the version increment is determined by reading
commit/merge commit messages for markers describing the change severity.
diff --git a/src/GitVersionCore.Tests/ConfigProviderTests.CanWriteOutEffectiveConfiguration.approved.txt b/src/GitVersionCore.Tests/ConfigProviderTests.CanWriteOutEffectiveConfiguration.approved.txt
@@ -2,6 +2,10 @@
 mode: ContinuousDelivery
 tag-prefix: '[vV]'
 continuous-delivery-fallback-tag: ci
+major-version-bump-message: '\+semver:\s?(breaking|major)'
+minor-version-bump-message: '\+semver:\s?(feature|minor)'
+patch-version-bump-message: '\+semver:\s?(fix|patch)'
+commit-message-incrementing: Enabled
 branches:
   master:
     mode: ContinuousDelivery
diff --git a/src/GitVersionCore.Tests/TestEffectiveConfiguration.cs b/src/GitVersionCore.Tests/TestEffectiveConfiguration.cs
@@ -14,10 +14,16 @@ public TestEffectiveConfiguration(
             bool preventIncrementForMergedBranchVersion = false,
             string tagNumberPattern = null,
             string continuousDeploymentFallbackTag = "ci",
-            bool trackMergeTarget = false) : 
+            bool trackMergeTarget = false,
+            string majorMessage = null,
+            string minorMessage = null,
+            string patchMessage = null,
+            CommitMessageIncrementMode commitMessageMode = CommitMessageIncrementMode.Enabled) : 
                 base(assemblyVersioningScheme, versioningMode, gitTagPrefix, tag, nextVersion, IncrementStrategy.Patch, 
                     branchPrefixToTrim, preventIncrementForMergedBranchVersion, tagNumberPattern, continuousDeploymentFallbackTag,
-                    trackMergeTarget)
+                    trackMergeTarget,
+                    majorMessage, minorMessage, patchMessage,
+                    commitMessageMode)
         {
         }
     }
diff --git a/src/GitVersionCore/Configuration/BranchConfig.cs b/src/GitVersionCore/Configuration/BranchConfig.cs
@@ -16,6 +16,7 @@ public BranchConfig(BranchConfig branchConfiguration)
             PreventIncrementOfMergedBranchVersion = branchConfiguration.PreventIncrementOfMergedBranchVersion;
             TagNumberPattern = branchConfiguration.TagNumberPattern;
             TrackMergeTarget = branchConfiguration.TrackMergeTarget;
+            CommitMessageIncrementing = branchConfiguration.CommitMessageIncrementing;
         }
 
         [YamlMember(Alias = "mode")]
@@ -38,5 +39,8 @@ public BranchConfig(BranchConfig branchConfiguration)
 
         [YamlMember(Alias = "track-merge-target")]
         public bool? TrackMergeTarget { get; set; }
+        
+        [YamlMember(Alias = "commit-message-incrementing")]
+        public CommitMessageIncrementMode? CommitMessageIncrementing { get; set; }
     }
 }
diff --git a/src/GitVersionCore/Configuration/Config.cs b/src/GitVersionCore/Configuration/Config.cs
@@ -23,6 +23,18 @@ public class Config
         [YamlMember(Alias = "next-version")]
         public string NextVersion { get; set; }
 
+        [YamlMember(Alias = "major-version-bump-message")]
+        public string MajorVersionBumpMessage { get; set; }
+
+        [YamlMember(Alias = "minor-version-bump-message")]
+        public string MinorVersionBumpMessage { get; set; }
+
+        [YamlMember(Alias = "patch-version-bump-message")]
+        public string PatchVersionBumpMessage { get; set; }
+
+        [YamlMember(Alias = "commit-message-incrementing")]
+        public CommitMessageIncrementMode? CommitMessageIncrementing { get; set; }
+
         [YamlMember(Alias = "branches")]
         public Dictionary<string, BranchConfig> Branches
         {
diff --git a/src/GitVersionCore/Configuration/ConfigurationProvider.cs b/src/GitVersionCore/Configuration/ConfigurationProvider.cs
@@ -24,6 +24,10 @@ public static void ApplyDefaultsTo(Config config)
             config.TagPrefix = config.TagPrefix ?? DefaultTagPrefix;
             config.VersioningMode = config.VersioningMode ?? VersioningMode.ContinuousDelivery;
             config.ContinuousDeploymentFallbackTag = config.ContinuousDeploymentFallbackTag ?? "ci";
+            config.MajorVersionBumpMessage = config.MajorVersionBumpMessage ?? IncrementStrategyFinder.DefaultMajorPattern;
+            config.MinorVersionBumpMessage = config.MinorVersionBumpMessage ?? IncrementStrategyFinder.DefaultMinorPattern;
+            config.PatchVersionBumpMessage = config.PatchVersionBumpMessage ?? IncrementStrategyFinder.DefaultPatchPattern;
+            config.CommitMessageIncrementing = config.CommitMessageIncrementing ?? CommitMessageIncrementMode.Enabled;
             var configBranches = config.Branches.ToList();
 
             ApplyBranchDefaults(config, GetOrCreateBranchDefaults(config, "master"), defaultTag: string.Empty, defaultPreventIncrement: true);
diff --git a/src/GitVersionCore/Configuration/IncrementStrategy.cs b/src/GitVersionCore/Configuration/IncrementStrategy.cs
@@ -1,5 +1,7 @@
 ﻿namespace GitVersion
 {
+    using System;
+
     public enum IncrementStrategy
     {
         None,
@@ -9,6 +11,26 @@ public enum IncrementStrategy
         /// <summary>
         /// Uses the increment strategy from the branch the current branch was branched from
         /// </summary>
-        Inherit 
+        Inherit
+    }
+
+    public static class IncrementStrategyExtensions
+    {
+        public static VersionField ToVersionField(this IncrementStrategy strategy)
+        {
+            switch (strategy)
+            {
+                case IncrementStrategy.None:
+                    return VersionField.None;
+                case IncrementStrategy.Major:
+                    return VersionField.Major;
+                case IncrementStrategy.Minor:
+                    return VersionField.Minor;
+                case IncrementStrategy.Patch:
+                    return VersionField.Patch;
+                default:
+                    throw new ArgumentOutOfRangeException("strategy", strategy, null);
+            }
+        }
     }
 }
diff --git a/src/GitVersionCore/EffectiveConfiguration.cs b/src/GitVersionCore/EffectiveConfiguration.cs
@@ -13,7 +13,11 @@ public EffectiveConfiguration(
             bool preventIncrementForMergedBranchVersion, 
             string tagNumberPattern,
             string continuousDeploymentFallbackTag, 
-            bool trackMergeTarget)
+            bool trackMergeTarget,
+            string majorVersionBumpMessage,
+            string minorVersionBumpMessage,
+            string patchVersionBumpMessage,
+            CommitMessageIncrementMode commitMessageIncrementing)
         {
             AssemblyVersioningScheme = assemblyVersioningScheme;
             VersioningMode = versioningMode;
@@ -26,6 +30,10 @@ public EffectiveConfiguration(
             TagNumberPattern = tagNumberPattern;
             ContinuousDeploymentFallbackTag = continuousDeploymentFallbackTag;
             TrackMergeTarget = trackMergeTarget;
+            MajorVersionBumpMessage = majorVersionBumpMessage;
+            MinorVersionBumpMessage = minorVersionBumpMessage;
+            PatchVersionBumpMessage = patchVersionBumpMessage;
+            CommitMessageIncrementing = commitMessageIncrementing;
         }
 
         public VersioningMode VersioningMode { get; private set; }
@@ -55,5 +63,13 @@ public EffectiveConfiguration(
         public string ContinuousDeploymentFallbackTag { get; private set; }
 
         public bool TrackMergeTarget { get; private set; }
+
+        public string MajorVersionBumpMessage { get; private set; }
+        
+        public string MinorVersionBumpMessage { get; private set; }
+
+        public string PatchVersionBumpMessage { get; private set; }
+
+        public CommitMessageIncrementMode CommitMessageIncrementing { get; private set; }
     }
 }
diff --git a/src/GitVersionCore/FodyWeavers.xml b/src/GitVersionCore/FodyWeavers.xml
@@ -1,4 +1,4 @@
-﻿<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Weavers VerifyAssembly="true">
   <Caseless/>
   <JetBrainsAnnotations/>
diff --git a/src/GitVersionCore/GitVersionContext.cs b/src/GitVersionCore/GitVersionContext.cs
@@ -91,23 +91,33 @@ void CalculateEffectiveConfiguration()
                 throw new Exception(string.Format("Configuration value for 'TrackMergeTarget' for branch {0} has no value. (this should not happen, please report an issue)", currentBranchConfig.Key));
             if (!configuration.AssemblyVersioningScheme.HasValue)
                 throw new Exception("Configuration value for 'AssemblyVersioningScheme' has no value. (this should not happen, please report an issue)");
+            if (!configuration.CommitMessageIncrementing.HasValue)
+                throw new Exception("Configuration value for 'CommitMessageIncrementing' has no value. (this should not happen, please report an issue)");
 
             var versioningMode = currentBranchConfig.Value.VersioningMode.Value;
             var tag = currentBranchConfig.Value.Tag;
             var tagNumberPattern = currentBranchConfig.Value.TagNumberPattern;
             var incrementStrategy = currentBranchConfig.Value.Increment.Value;
             var preventIncrementForMergedBranchVersion = currentBranchConfig.Value.PreventIncrementOfMergedBranchVersion.Value;
             var trackMergeTarget = currentBranchConfig.Value.TrackMergeTarget.Value;
-
+            
             var nextVersion = configuration.NextVersion;
             var assemblyVersioningScheme = configuration.AssemblyVersioningScheme.Value;
             var gitTagPrefix = configuration.TagPrefix;
+            var majorMessage = configuration.MajorVersionBumpMessage;
+            var minorMessage = configuration.MinorVersionBumpMessage;
+            var patchMessage = configuration.MinorVersionBumpMessage;
+
+            var commitMessageVersionBump = currentBranchConfig.Value.CommitMessageIncrementing ?? configuration.CommitMessageIncrementing.Value;
+
             Configuration = new EffectiveConfiguration(
                 assemblyVersioningScheme, versioningMode, gitTagPrefix, 
                 tag, nextVersion, incrementStrategy, currentBranchConfig.Key, 
                 preventIncrementForMergedBranchVersion, 
                 tagNumberPattern, configuration.ContinuousDeploymentFallbackTag,
-                trackMergeTarget);
+                trackMergeTarget,
+                majorMessage, minorMessage, patchMessage,
+                commitMessageVersionBump);
         }
     }
 }
diff --git a/src/GitVersionCore/GitVersionCore.csproj b/src/GitVersionCore/GitVersionCore.csproj
@@ -113,6 +113,7 @@
     <Compile Include="Helpers\IFileSystem.cs" />
     <Compile Include="Helpers\ProcessHelper.cs" />
     <Compile Include="Helpers\ServiceMessageEscapeHelper.cs" />
+    <Compile Include="IncrementStrategyFinder.cs" />
     <Compile Include="OutputVariables\VersionVariables.cs" />
     <Compile Include="Extensions\ExtensionMethods.git.cs" />
     <Compile Include="SemanticVersionExtensions.cs" />
diff --git a/src/GitVersionCore/IncrementStrategyFinder.cs b/src/GitVersionCore/IncrementStrategyFinder.cs
@@ -0,0 +1,107 @@
+﻿namespace GitVersion
+{
+    using System.Collections.Generic;
+    using System.Linq;
+    using System.Text.RegularExpressions;
+    using VersionCalculation.BaseVersionCalculators;
+    using LibGit2Sharp;
+
+    public enum CommitMessageIncrementMode
+    {
+        Enabled,
+        Disabled,
+        MergeMessageOnly
+    }
+
+    public static class IncrementStrategyFinder
+    {
+        public const string DefaultMajorPattern = @"\+semver:\s?(breaking|major)";
+        public const string DefaultMinorPattern = @"\+semver:\s?(feature|minor)";
+        public const string DefaultPatchPattern = @"\+semver:\s?(fix|patch)";
+
+        public static VersionField? DetermineIncrementedField(GitVersionContext context, BaseVersion baseVersion)
+        {
+            var commitMessageIncrement = FindCommitMessageIncrement(context, baseVersion);
+            var defaultIncrement = context.Configuration.Increment.ToVersionField();
+
+            // use the default branch config increment strategy if there are no commit message overrides
+            if (commitMessageIncrement == null)
+            {
+                return baseVersion.ShouldIncrement ? defaultIncrement : (VersionField?)null;
+            }
+
+            // cap the commit message severity to minor for alpha versions
+            if (baseVersion.SemanticVersion < new SemanticVersion(1) && commitMessageIncrement > VersionField.Minor)
+            {
+                commitMessageIncrement = VersionField.Minor;
+            }
+
+            // don't increment for less than the branch config increment, if the absense of commit messages would have
+            // still resulted in an increment of configuration.Increment
+            if (baseVersion.ShouldIncrement && commitMessageIncrement < defaultIncrement)
+            {
+                return defaultIncrement;
+            }
+
+            return commitMessageIncrement;
+        }
+
+        private static VersionField? FindCommitMessageIncrement(GitVersionContext context, BaseVersion baseVersion)
+        {
+            if (context.Configuration.CommitMessageIncrementing == CommitMessageIncrementMode.Disabled)
+            {
+                return null;
+            }
+            
+            var commits = GetIntermediateCommits(context.Repository, baseVersion.BaseVersionSource, context.CurrentCommit);
+
+            if (context.Configuration.CommitMessageIncrementing == CommitMessageIncrementMode.MergeMessageOnly)
+            {
+                commits = commits.Where(c => c.Parents.Count() > 1);
+            }
+
+            var majorRegex = CreateRegex(context.Configuration.MajorVersionBumpMessage ?? DefaultMajorPattern);
+            var minorRegex = CreateRegex(context.Configuration.MinorVersionBumpMessage ?? DefaultMinorPattern);
+            var patchRegex = CreateRegex(context.Configuration.PatchVersionBumpMessage ?? DefaultPatchPattern);
+
+            var increments = commits
+                .Select(c => FindIncrementFromMessage(c.Message, majorRegex, minorRegex, patchRegex))
+                .Where(v => v != null)
+                .Select(v => v.Value)
+                .ToList();
+
+            if (increments.Any())
+            {
+                return increments.Max();
+            }
+
+            return null;
+        }
+        
+        private static IEnumerable<Commit> GetIntermediateCommits(IRepository repo, Commit baseCommit, Commit headCommit)
+        {
+            var filter = new CommitFilter
+            {
+                Since = headCommit,
+                Until = baseCommit,
+                SortBy = CommitSortStrategies.Topological | CommitSortStrategies.Reverse
+            };
+
+            return repo.Commits.QueryBy(filter);
+        }
+
+        private static VersionField? FindIncrementFromMessage(string message, Regex major, Regex minor, Regex patch)
+        {
+            if (major.IsMatch(message)) return VersionField.Major;
+            if (minor.IsMatch(message)) return VersionField.Minor;
+            if (patch.IsMatch(message)) return VersionField.Patch;
+
+            return null;
+        }
+
+        private static Regex CreateRegex(string pattern)
+        {
+            return new Regex(pattern, RegexOptions.Compiled | RegexOptions.IgnoreCase);
+        }
+    }
+}
diff --git a/src/GitVersionCore/SemanticVersion.cs b/src/GitVersionCore/SemanticVersion.cs
@@ -281,25 +281,25 @@ public string ToString(string format, IFormatProvider formatProvider = null)
             }
         }
 
-        public SemanticVersion IncrementVersion(IncrementStrategy incrementStrategy)
+        public SemanticVersion IncrementVersion(VersionField incrementStrategy)
         {
             var incremented = new SemanticVersion(this);
             if (!incremented.PreReleaseTag.HasTag())
             {
                 switch (incrementStrategy)
                 {
-                    case IncrementStrategy.None:
+                    case VersionField.None:
                         break;
-                    case IncrementStrategy.Major:
+                    case VersionField.Major:
                         incremented.Major++;
                         incremented.Minor = 0;
                         incremented.Patch = 0;
                         break;
-                    case IncrementStrategy.Minor:
+                    case VersionField.Minor:
                         incremented.Minor++;
                         incremented.Patch = 0;
                         break;
-                    case IncrementStrategy.Patch:
+                    case VersionField.Patch:
                         incremented.Patch++;
                         break;
                     default:
@@ -318,4 +318,12 @@ public SemanticVersion IncrementVersion(IncrementStrategy incrementStrategy)
             return incremented;
         }
     }
+
+    public enum VersionField
+    {
+        None,
+        Patch,
+        Minor,
+        Major
+    }
 }
diff --git a/src/GitVersionCore/VersionCalculation/BaseVersionCalculator.cs b/src/GitVersionCore/VersionCalculation/BaseVersionCalculator.cs
@@ -74,7 +74,13 @@ public BaseVersion GetBaseVersion(GitVersionContext context)
 
         static SemanticVersion MaybeIncrement(GitVersionContext context, BaseVersion version)
         {
-            return version.ShouldIncrement ? version.SemanticVersion.IncrementVersion(context.Configuration.Increment) : version.SemanticVersion;
+            var increment = IncrementStrategyFinder.DetermineIncrementedField(context, version);
+            if (increment != null)
+            {
+                return version.SemanticVersion.IncrementVersion(increment.Value);
+            }
+
+            return version.SemanticVersion;
         }
     }
 }
diff --git a/src/GitVersionCore/VersionCalculation/NextVersionCalculator.cs b/src/GitVersionCore/VersionCalculation/NextVersionCalculator.cs
@@ -38,9 +38,10 @@ public SemanticVersion FindVersion(GitVersionContext context)
 
             var baseVersion = baseVersionFinder.GetBaseVersion(context);
             var semver = baseVersion.SemanticVersion;
-            if (baseVersion.ShouldIncrement)
+            var increment = IncrementStrategyFinder.DetermineIncrementedField(context, baseVersion);
+            if (increment != null)
             {
-                semver = semver.IncrementVersion(context.Configuration.Increment);
+                semver = semver.IncrementVersion(increment.Value);
             }
             else Logger.WriteInfo("Skipping version increment");
 
diff --git a/src/GitVersionCore/packages.config b/src/GitVersionCore/packages.config
@@ -5,6 +5,6 @@
   <package id="JetBrainsAnnotations.Fody" version="1.0.4.0" targetFramework="net40" developmentDependency="true" />
   <package id="LibGit2Sharp" version="0.21.0.176" targetFramework="net40" />
   <package id="PepitaPackage" version="1.21.4" targetFramework="net40" developmentDependency="true" />
-  <package id="Visualize.Fody" version="0.4.3.0" targetFramework="net40" developmentDependency="true" />
+  <package id="Visualize.Fody" version="0.4.4.0" targetFramework="net40" developmentDependency="true" />
   <package id="YamlDotNet" version="3.6.1" targetFramework="net40" />
 </packages>
diff --git a/src/GitVersionExe/FodyWeavers.xml b/src/GitVersionExe/FodyWeavers.xml
diff --git a/src/GitVersionExe/packages.config b/src/GitVersionExe/packages.config

Original file line number	Diff line number	Diff line change
`@@ -14,10 +14,16 @@ public TestEffectiveConfiguration(`
`14`	`14`	`bool preventIncrementForMergedBranchVersion = false,`
`15`	`15`	`string tagNumberPattern = null,`
`16`	`16`	`string continuousDeploymentFallbackTag = "ci",`
`17`		`- bool trackMergeTarget = false) :`
	`17`	`+ bool trackMergeTarget = false,`
	`18`	`+ string majorMessage = null,`
	`19`	`+ string minorMessage = null,`
	`20`	`+ string patchMessage = null,`
	`21`	`+ CommitMessageIncrementMode commitMessageMode = CommitMessageIncrementMode.Enabled) :`
`18`	`22`	`base(assemblyVersioningScheme, versioningMode, gitTagPrefix, tag, nextVersion, IncrementStrategy.Patch,`
`19`	`23`	`branchPrefixToTrim, preventIncrementForMergedBranchVersion, tagNumberPattern, continuousDeploymentFallbackTag,`
`20`		`- trackMergeTarget)`
	`24`	`+ trackMergeTarget,`
	`25`	`+ majorMessage, minorMessage, patchMessage,`
	`26`	`+ commitMessageMode)`
`21`	`27`	`{`
`22`	`28`	`}`
`23`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ public BranchConfig(BranchConfig branchConfiguration)`
`16`	`16`	`PreventIncrementOfMergedBranchVersion = branchConfiguration.PreventIncrementOfMergedBranchVersion;`
`17`	`17`	`TagNumberPattern = branchConfiguration.TagNumberPattern;`
`18`	`18`	`TrackMergeTarget = branchConfiguration.TrackMergeTarget;`
	`19`	`+ CommitMessageIncrementing = branchConfiguration.CommitMessageIncrementing;`
`19`	`20`	`}`
`20`	`21`
`21`	`22`	`[YamlMember(Alias = "mode")]`
`@@ -38,5 +39,8 @@ public BranchConfig(BranchConfig branchConfiguration)`
`38`	`39`
`39`	`40`	`[YamlMember(Alias = "track-merge-target")]`
`40`	`41`	`public bool? TrackMergeTarget { get; set; }`
	`42`	`+`
	`43`	`+ [YamlMember(Alias = "commit-message-incrementing")]`
	`44`	`+ public CommitMessageIncrementMode? CommitMessageIncrementing { get; set; }`
`41`	`45`	`}`
`42`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-<?xml version="1.0" encoding="utf-8"?>`
	`1`	`+<?xml version="1.0" encoding="utf-8"?>`
`2`	`2`	`<Weavers VerifyAssembly="true">`
`3`	`3`	`<Caseless/>`
`4`	`4`	`<JetBrainsAnnotations/>`