Add feature ignore regex for commit messages

docs/configuration.md

@@ -45,9 +45,12 @@ build-metadata-padding: 4
 commits-since-version-source-padding: 4
 commit-message-incrementing: Enabled
 commit-date-format: 'yyyy-MM-dd'
+merge-message-version: Enabled
+
 ignore:
   sha: []
   commits-before: yyyy-MM-ddTHH:mm:ss
+  merge-message: '<message regex>'
 ```
 
 And the description of the available options are:
@@ -153,6 +156,10 @@ details on the syntax. Default set to `Enabled`; set to `Disabled` to disable.
 ### commit-date-format
 Sets the format which will be used to format the `CommitDate` output variable.
 
+#### merge-message-version
+This configuration can be used to disable merge message version detection, where the version
+is infered from the commit message.
+
 ### ignore
 The header for ignore configuration.
 
@@ -179,6 +186,10 @@ Date and time in the format `yyyy-MM-ddTHH:mm:ss` (eg `commits-before:
 2015-10-23T12:23:15`) to setup an exclusion range. Effectively any commit before
 `commits-before` will be ignored.
 
+#### merge-message
+The regex to match commit messages that will be ignored. Useful to exclude for example
+pull request from an automatic nuget updater.
+
 ## Branch configuration
 Then we have branch specific configuration, which looks something like this:
 

src/GitVersionCore.Tests/CommitDateTests.cs

@@ -1,4 +1,6 @@
 using System;
+using System.Collections;
+using System.Collections.Generic;
 using System.Linq;
 using GitVersion;
 using GitVersion.VersionFilters;
@@ -26,7 +28,7 @@ public void CommitDateFormatTest(string format, string expectedOutcome)
                                     },
                                     new EffectiveConfiguration(
                                         AssemblyVersioningScheme.MajorMinorPatch, AssemblyFileVersioningScheme.MajorMinorPatch, "", "", "", VersioningMode.ContinuousDelivery, "", "", "", IncrementStrategy.Inherit,
-                                        "", true, "", "", false, "", "", "", "", CommitMessageIncrementMode.Enabled, 4, 4, 4, Enumerable.Empty<IVersionFilter>(), false, true, format)
+                                        "", true, "", "", false, "", "", "", "", CommitMessageIncrementMode.Enabled, 4, 4, 4, Enumerable.Empty<IVersionFilter>(), false, true, format, true)
                                 );
 
             Assert.That(formatValues.CommitDate, Is.EqualTo(expectedOutcome));

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

@@ -11,6 +11,7 @@ legacy-semver-padding: 4
 build-metadata-padding: 4
 commits-since-version-source-padding: 4
 commit-message-incrementing: Enabled
+merge-message-version: Enabled
 branches:
   develop:
     mode: ContinuousDeployment

src/GitVersionCore.Tests/TestEffectiveConfiguration.cs

@@ -33,15 +33,16 @@ public TestEffectiveConfiguration(
             IEnumerable<IVersionFilter> versionFilters = null,
             bool tracksReleaseBranches = false,
             bool isRelease = false,
-            string commitDateFormat = "yyyy-MM-dd") :
+            string commitDateFormat = "yyyy-MM-dd",
+            bool mergeMessageVersion = true) :
             base(assemblyVersioningScheme, assemblyFileVersioningScheme, assemblyInformationalFormat, assemblyVersioningFormat, assemblyFileVersioningFormat, versioningMode, gitTagPrefix, tag, nextVersion, IncrementStrategy.Patch,
                     branchPrefixToTrim, preventIncrementForMergedBranchVersion, tagNumberPattern, continuousDeploymentFallbackTag,
                     trackMergeTarget,
                     majorMessage, minorMessage, patchMessage, noBumpMessage,
                     commitMessageMode, legacySemVerPadding, buildMetaDataPadding, commitsSinceVersionSourcePadding,
                     versionFilters ?? Enumerable.Empty<IVersionFilter>(),
-                    tracksReleaseBranches, isRelease, commitDateFormat)
+                    tracksReleaseBranches, isRelease, commitDateFormat, mergeMessageVersion)
         {
         }
     }
-}
+}

src/GitVersionCore/Configuration/BranchConfig.cs

@@ -1,4 +1,4 @@
-namespace GitVersion
+namespace GitVersion
 {
     using System.Collections.Generic;
     using YamlDotNet.Serialization;
@@ -54,8 +54,8 @@ public BranchConfig(BranchConfig branchConfiguration)
         [YamlMember(Alias = "commit-message-incrementing")]
         public CommitMessageIncrementMode? CommitMessageIncrementing { get; set; }
 
-        [YamlMember(Alias = "regex")]
-        public string Regex { get; set; }
+        [YamlMember(Alias = "merge-message")]
+        public string MergeMessage { get; set; }
 
         [YamlMember(Alias = "source-branches")]
         public List<string> SourceBranches { get; set; }

src/GitVersionCore/Configuration/Config.cs

@@ -78,6 +78,9 @@ public string NextVersion
         [YamlMember(Alias = "commit-message-incrementing")]
         public CommitMessageIncrementMode? CommitMessageIncrementing { get; set; }
 
+        [YamlMember(Alias = "merge-message-version")]
+        public bool? MergeMessageVersion { get; set; }
+
         [YamlMember(Alias = "branches")]
         public Dictionary<string, BranchConfig> Branches
         {

src/GitVersionCore/Configuration/ConfigurationProvider.cs

@@ -101,6 +101,7 @@ public static void ApplyDefaultsTo(Config config)
             config.BuildMetaDataPadding = config.BuildMetaDataPadding ?? 4;
             config.CommitsSinceVersionSourcePadding = config.CommitsSinceVersionSourcePadding ?? 4;
             config.CommitDateFormat = config.CommitDateFormat ?? "yyyy-MM-dd";
+            config.MergeMessageVersion = config.MergeMessageVersion ?? true;
 
             var configBranches = config.Branches.ToList();
 

src/GitVersionCore/Configuration/IgnoreConfig.cs

@@ -1,4 +1,4 @@
-namespace GitVersion
+namespace GitVersion
 {
     using System;
     using System.Collections.Generic;
@@ -19,10 +19,14 @@ public IgnoreConfig()
         [YamlMember(Alias = "sha")]
         public IEnumerable<string> SHAs { get; set; }
 
+        [YamlMember(Alias = "merge-message")]
+        public string MergeMessage { get; set; }
+
         public virtual IEnumerable<IVersionFilter> ToFilters()
         {
             if (SHAs.Any()) yield return new ShaVersionFilter(SHAs);
             if (Before.HasValue) yield return new MinDateVersionFilter(Before.Value);
+            if (!string.IsNullOrWhiteSpace(MergeMessage)) yield return new MessageFilter(MergeMessage);
         }
     }
-}
+}

src/GitVersionCore/EffectiveConfiguration.cs

@@ -1,4 +1,4 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using GitVersion.VersionFilters;
 
 namespace GitVersion
@@ -32,7 +32,8 @@ public EffectiveConfiguration(
             IEnumerable<IVersionFilter> versionFilters,
             bool tracksReleaseBranches,
             bool isCurrentBranchRelease,
-            string commitDateFormat)
+            string commitDateFormat,
+            bool mergeMessageVersion)
         {
             AssemblyVersioningScheme = assemblyVersioningScheme;
             AssemblyFileVersioningScheme = assemblyFileVersioningScheme;
@@ -61,7 +62,8 @@ public EffectiveConfiguration(
             TracksReleaseBranches = tracksReleaseBranches;
             IsCurrentBranchRelease = isCurrentBranchRelease;
             CommitDateFormat = commitDateFormat;
-        }
+            MergeMessageVersion = mergeMessageVersion;
+    }
 
         public bool TracksReleaseBranches { get; private set; }
         public bool IsCurrentBranchRelease { get; private set; }
@@ -115,5 +117,7 @@ public EffectiveConfiguration(
         public IEnumerable<IVersionFilter> VersionFilters { get; private set; }
 
         public string CommitDateFormat { get; private set; }
+
+        public bool MergeMessageVersion { get; private set; }
     }
-}
+}

src/GitVersionCore/GitVersionContext.cs

@@ -1,4 +1,4 @@
-namespace GitVersion
+namespace GitVersion
 {
     using LibGit2Sharp;
     using System;
@@ -110,6 +110,8 @@ void CalculateEffectiveConfiguration()
                 throw new Exception("Configuration value for 'BuildMetaDataPadding' has no value. (this should not happen, please report an issue)");
             if (!FullConfiguration.CommitsSinceVersionSourcePadding.HasValue)
                 throw new Exception("Configuration value for 'CommitsSinceVersionSourcePadding' has no value. (this should not happen, please report an issue)");
+            if (!FullConfiguration.MergeMessageVersion.HasValue)
+                throw new Exception("Configuration value for 'MergeMessageVersion' has no value. (this should not happen, please report an issue)");
 
             var versioningMode = currentBranchConfig.VersioningMode.Value;
             var tag = currentBranchConfig.Tag;
@@ -130,7 +132,7 @@ void CalculateEffectiveConfiguration()
             var patchMessage = FullConfiguration.PatchVersionBumpMessage;
             var noBumpMessage = FullConfiguration.NoBumpMessage;
             var commitDateFormat = FullConfiguration.CommitDateFormat;
-
+            var mergeMessageVersion = FullConfiguration.MergeMessageVersion.Value;
             var commitMessageVersionBump = currentBranchConfig.CommitMessageIncrementing ?? FullConfiguration.CommitMessageIncrementing.Value;
 
             Configuration = new EffectiveConfiguration(
@@ -148,7 +150,8 @@ void CalculateEffectiveConfiguration()
                 FullConfiguration.Ignore.ToFilters(),
                 currentBranchConfig.TracksReleaseBranches.Value,
                 currentBranchConfig.IsReleaseBranch.Value,
-                commitDateFormat);
+                commitDateFormat,
+                mergeMessageVersion);
         }
 
         private static Branch GetTargetBranch(IRepository repository, string targetBranch)

src/GitVersionCore/VersionCalculation/BaseVersionCalculators/MergeMessageBaseVersionStrategy.cs

@@ -14,6 +14,11 @@ public class MergeMessageBaseVersionStrategy : BaseVersionStrategy
     {
         public override IEnumerable<BaseVersion> GetVersions(GitVersionContext context)
         {
+            if (!context.Configuration.MergeMessageVersion)
+            {
+                return Enumerable.Empty<BaseVersion>();
+            }
+
             var commitsPriorToThan = context.CurrentBranch
                 .CommitsPriorToThan(context.CurrentCommit.When());
             var baseVersions = commitsPriorToThan

src/GitVersionCore/VersionFilters/MessageFilter.cs

@@ -0,0 +1,35 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using System.Text.RegularExpressions;
+using GitVersion.VersionCalculation.BaseVersionCalculators;
+
+namespace GitVersion.VersionFilters
+{
+    public class MessageFilter : IVersionFilter
+    {
+        private readonly Regex regex;
+
+        public MessageFilter(string regex)
+        {
+            if (regex == null) throw new ArgumentNullException(nameof(regex));
+            this.regex = new Regex(regex); ;
+        }
+
+        public bool Exclude(BaseVersion version, out string reason)
+        {
+            if (version == null) throw new ArgumentNullException(nameof(version));
+
+            reason = null;
+
+            if (version.BaseVersionSource != null &&
+                regex.Match(version.BaseVersionSource.Message).Success)
+            {
+                reason = $"Message {version.BaseVersionSource.Message} was ignored due to commit having been excluded by configuration";
+                return true;
+            }
+
+            return false;
+        }
+    }
+}

src/GitVersionExe.Tests/TestEffectiveConfiguration.cs

@@ -33,16 +33,17 @@ public TestEffectiveConfiguration(
             IEnumerable<IVersionFilter> versionFilters = null,
             bool tracksReleaseBranches = false,
             bool isRelease = false,
-            string commitDateFormat = "yyyy-MM-dd") :
+            string commitDateFormat = "yyyy-MM-dd",
+            bool mergeMessageVersion = true) :
              base(assemblyVersioningScheme, assemblyFileVersioningScheme, assemblyInformationalFormat, assemblyVersioningFormat, assemblyFileVersioningFormat, versioningMode, gitTagPrefix, tag, nextVersion, IncrementStrategy.Patch,
                     branchPrefixToTrim, preventIncrementForMergedBranchVersion, tagNumberPattern, continuousDeploymentFallbackTag,
                     trackMergeTarget,
                     majorMessage, minorMessage, patchMessage, noBumpMessage,
                     commitMessageMode, legacySemVerPadding, buildMetaDataPadding, commitsSinceVersionSourcePadding,
                     versionFilters ?? Enumerable.Empty<IVersionFilter>(),
-                    tracksReleaseBranches, isRelease, commitDateFormat)
+                    tracksReleaseBranches, isRelease, commitDateFormat, mergeMessageVersion)
 
         {
         }
     }
-}
+}

src/GitVersionTask.Tests/Helpers/TestEffectiveConfiguration.cs

@@ -33,15 +33,16 @@ public TestEffectiveConfiguration(
             IEnumerable<IVersionFilter> versionFilters = null,
             bool tracksReleaseBranches = false,
             bool isRelease = false,
-            string commitDateFormat = "yyyy-MM-dd") :
+            string commitDateFormat = "yyyy-MM-dd",
+            bool mergeMessageVersion = true) :
             base(assemblyVersioningScheme, assemblyFileVersioningScheme, assemblyInformationalFormat, assemblyVersioningFormat, assemblyFileVersioningFormat, versioningMode, gitTagPrefix, tag, nextVersion, IncrementStrategy.Patch,
                     branchPrefixToTrim, preventIncrementForMergedBranchVersion, tagNumberPattern, continuousDeploymentFallbackTag,
                     trackMergeTarget,
                     majorMessage, minorMessage, patchMessage, noBumpMessage,
                     commitMessageMode, legacySemVerPadding, buildMetaDataPadding, commitsSinceVersionSourcePadding,
                     versionFilters ?? Enumerable.Empty<IVersionFilter>(),
-                    tracksReleaseBranches, isRelease, commitDateFormat)
+                    tracksReleaseBranches, isRelease, commitDateFormat, mergeMessageVersion)
         {
         }
     }
-}
+}