add setting for commit message prefix --commitmessageprefix

NuKeeper.Abstractions/CollaborationPlatform/ICommitWorder.cs

@@ -7,7 +7,7 @@ public interface ICommitWorder
     {
         string MakePullRequestTitle(IReadOnlyCollection<PackageUpdateSet> updates);
 
-        string MakeCommitMessage(PackageUpdateSet updates);
+        string MakeCommitMessage(PackageUpdateSet updates, string commitMessagePrefix);
 
         string MakeCommitDetails(IReadOnlyCollection<PackageUpdateSet> updates);
     }

NuKeeper.Abstractions/Configuration/CommitSettings.cs

@@ -0,0 +1,7 @@
+namespace NuKeeper.Abstractions.Configuration
+{
+    public class CommitSettings
+    {
+        public string CommitMessagePrefix { get; set; }
+    }
+}

NuKeeper.Abstractions/Configuration/FileSettings.cs

@@ -42,6 +42,8 @@ public class FileSettings
         public string BranchNameTemplate { get; set; }
         public bool? DeleteBranchAfterMerge { get; set; }
 
+        public string CommitMessagePrefix { get; set; }
+
         public string GitCliPath { get; set; }
         public int? MaxOpenPullRequests { get; set; }
 

NuKeeper.Abstractions/Configuration/SettingsContainer.cs

@@ -12,6 +12,8 @@ public class SettingsContainer
 
         public BranchSettings BranchSettings { get; set; }
 
+        public CommitSettings CommitSettings { get; set; }
+
         public IFolder WorkingFolder { get; set; }
     }
 }

NuKeeper.AzureDevOps/AzureDevOpsCommitWorder.cs

@@ -38,14 +38,14 @@ private static string PackageTitle(PackageUpdateSet updates)
             return $"{CommitEmoji} Automatic update of {updates.SelectedId} to {updates.SelectedVersion}";
         }
 
-        public string MakeCommitMessage(PackageUpdateSet updates)
+        public string MakeCommitMessage(PackageUpdateSet updates, string commitMessagePrefix)
         {
             if (updates == null)
             {
                 throw new ArgumentNullException(nameof(updates));
             }
 
-            return $"{PackageTitle(updates)}";
+            return $"{commitMessagePrefix}{PackageTitle(updates)}";
         }
 
         public string MakeCommitDetails(IReadOnlyCollection<PackageUpdateSet> updates)

NuKeeper.BitBucket/BitbucketCommitWorder.cs

@@ -34,14 +34,14 @@ private static string PackageTitle(PackageUpdateSet updates)
             return $"Automatic update of {updates.SelectedId} to {updates.SelectedVersion}";
         }
 
-        public string MakeCommitMessage(PackageUpdateSet updates)
+        public string MakeCommitMessage(PackageUpdateSet updates, string commitMessagePrefix)
         {
             if (updates == null)
             {
                 throw new ArgumentNullException(nameof(updates));
             }
 
-            return $":{CommitEmoji}: {PackageTitle(updates)}";
+            return $"{commitMessagePrefix}:{CommitEmoji}: {PackageTitle(updates)}";
         }
 
         public string MakeCommitDetails(IReadOnlyCollection<PackageUpdateSet> updates)

NuKeeper.Integration.Tests/Engine/ExistingCommitFilterTest.cs

@@ -38,7 +38,7 @@ public async Task DoFilter()
 
             var subject = MakeExistingCommitFilter();
 
-            var result = await subject.Filter(git, updates.AsReadOnly(), "base", "head");
+            var result = await subject.Filter(git, updates.AsReadOnly(), "base", "head", string.Empty);
 
             Assert.AreEqual(1, result.Count);
             Assert.AreEqual("First.Nuget", result.FirstOrDefault()?.SelectedId);
@@ -64,7 +64,7 @@ public async Task DoNotFilter()
 
             var subject = MakeExistingCommitFilter();
 
-            var result = await subject.Filter(git, updates.AsReadOnly(), "base", "head");
+            var result = await subject.Filter(git, updates.AsReadOnly(), "base", "head", string.Empty);
 
             Assert.AreEqual(2, result.Count);
         }
@@ -77,7 +77,7 @@ private IExistingCommitFilter MakeExistingCommitFilter()
             collaborationFactory.CollaborationPlatform.Returns(gitClient);
 
             var commitWorder = Substitute.For<ICommitWorder>();
-            commitWorder.MakeCommitMessage(Arg.Any<PackageUpdateSet>()).Returns(p => $"Automatic update of {((PackageUpdateSet)p[0]).SelectedId} to {((PackageUpdateSet)p[0]).SelectedVersion}");
+            commitWorder.MakeCommitMessage(Arg.Any<PackageUpdateSet>(), Arg.Any<string>()).Returns(p => $"Automatic update of {((PackageUpdateSet)p[0]).SelectedId} to {((PackageUpdateSet)p[0]).SelectedVersion}");
             collaborationFactory.CommitWorder.Returns(commitWorder);
 
             return new ExistingCommitFilter(collaborationFactory, NukeeperLogger);

NuKeeper.Tests/Engine/DefaultCommitWorderTests.cs

@@ -39,35 +39,35 @@ public void MakeCommitMessage_OneUpdateIsCorrect()
         {
             var updates = PackageUpdates.For(MakePackageForV110());
 
-            var report = _sut.MakeCommitMessage(updates);
+            var report = _sut.MakeCommitMessage(updates, "someprefix: ");
 
             Assert.That(report, Is.Not.Null);
             Assert.That(report, Is.Not.Empty);
-            Assert.That(report, Is.EqualTo(":package: Automatic update of foo.bar to 1.2.3"));
+            Assert.That(report, Is.EqualTo("someprefix: :package: Automatic update of foo.bar to 1.2.3"));
         }
 
         [Test]
         public void MakeCommitMessage_TwoUpdatesIsCorrect()
         {
             var updates = PackageUpdates.For(MakePackageForV110(), MakePackageForV100());
 
-            var report = _sut.MakeCommitMessage(updates);
+            var report = _sut.MakeCommitMessage(updates, "someprefix: ");
 
             Assert.That(report, Is.Not.Null);
             Assert.That(report, Is.Not.Empty);
-            Assert.That(report, Is.EqualTo(":package: Automatic update of foo.bar to 1.2.3"));
+            Assert.That(report, Is.EqualTo("someprefix: :package: Automatic update of foo.bar to 1.2.3"));
         }
 
         [Test]
         public void MakeCommitMessage_TwoUpdatesSameVersionIsCorrect()
         {
             var updates = PackageUpdates.For(MakePackageForV110(), MakePackageForV110InProject3());
 
-            var report = _sut.MakeCommitMessage(updates);
+            var report = _sut.MakeCommitMessage(updates, "someprefix: ");
 
             Assert.That(report, Is.Not.Null);
             Assert.That(report, Is.Not.Empty);
-            Assert.That(report, Is.EqualTo(":package: Automatic update of foo.bar to 1.2.3"));
+            Assert.That(report, Is.EqualTo("someprefix: :package: Automatic update of foo.bar to 1.2.3"));
         }
 
 

NuKeeper.Tests/Engine/Packages/PackageUpdaterTests.cs

@@ -39,6 +39,7 @@ public void Initialize()
                     Arg.Any<IGitDriver>(),
                     Arg.Any<IReadOnlyCollection<PackageUpdateSet>>(),
                     Arg.Any<string>(),
+                    Arg.Any<string>(),
                     Arg.Any<string>()
                 )
                 .Returns(ci => ((IReadOnlyCollection<PackageUpdateSet>)ci[1]));
@@ -115,6 +116,7 @@ public async Task MakeUpdatePullRequest_UpdateDoesNotCreatePrDueToExistingCommit
                     Arg.Any<IGitDriver>(),
                     Arg.Any<IReadOnlyCollection<PackageUpdateSet>>(),
                     Arg.Any<string>(),
+                    Arg.Any<string>(),
                     Arg.Any<string>()
                 )
                 .Returns(new List<PackageUpdateSet>(), new List<PackageUpdateSet> { packageSetTwo });
@@ -245,6 +247,10 @@ private static SettingsContainer MakeSettings(
                 {
                     MaxPackageUpdates = 3,
                     MinimumAge = new TimeSpan(7, 0, 0, 0),
+                },
+                CommitSettings = new CommitSettings
+                {
+                    CommitMessagePrefix = string.Empty
                 }
             };
         }

NuKeeper.Tests/Engine/RepositoryUpdaterTests.cs

@@ -152,7 +152,7 @@ int expectedPrs
 
             var filteredUpdates = updates.Skip(existingCommitsPerBranch).ToList().AsReadOnly();
 
-            existingCommitFilder.Filter(Arg.Any<IGitDriver>(), Arg.Any<IReadOnlyCollection<PackageUpdateSet>>(), Arg.Any<string>(), Arg.Any<string>()).Returns(filteredUpdates);
+            existingCommitFilder.Filter(Arg.Any<IGitDriver>(), Arg.Any<IReadOnlyCollection<PackageUpdateSet>>(), Arg.Any<string>(), Arg.Any<string>(), Arg.Any<string>()).Returns(filteredUpdates);
 
             var settings = MakeSettings(consolidateUpdates);
 
@@ -358,6 +358,10 @@ private static SettingsContainer MakeSettings(
                 {
                     MaxPackageUpdates = 3,
                     MinimumAge = new TimeSpan(7, 0, 0, 0),
+                },
+                CommitSettings = new CommitSettings
+                {
+                    CommitMessagePrefix = string.Empty
                 }
             };
         }

NuKeeper/Commands/CommandBase.cs

@@ -81,6 +81,10 @@ internal abstract class CommandBase
             Description = "Template used for creating the branch name.")]
         public string BranchNameTemplate { get; set; }
 
+        [Option(CommandOptionType.SingleValue, ShortName = "", LongName = "commitmessageprefix",
+            Description = "Prefix used for the package update commit messages, e. g. an issue number")]
+        public string CommitMessagePrefix { get; set; }
+
         [Option(CommandOptionType.SingleValue, ShortName = "git", LongName = "gitclipath",
             Description = "Path to git to use instead of lib2gitsharp implementation")]
         public string GitCliPath { get; set; }
@@ -131,6 +135,7 @@ private SettingsContainer MakeSettings()
             var allowedChange = Concat.FirstValue(AllowedChange, fileSettings.Change, VersionChange.Major);
             var usePrerelease = Concat.FirstValue(UsePrerelease, fileSettings.UsePrerelease, Abstractions.Configuration.UsePrerelease.FromPrerelease);
             var branchNameTemplate = Concat.FirstValue(BranchNameTemplate, fileSettings.BranchNameTemplate);
+            var commitMessagePrefix = Concat.FirstValue(CommitMessagePrefix, fileSettings.CommitMessagePrefix);
             var gitpath = Concat.FirstValue(GitCliPath, fileSettings.GitCliPath);
 
             var settings = new SettingsContainer
@@ -147,6 +152,10 @@ private SettingsContainer MakeSettings()
                 BranchSettings = new BranchSettings
                 {
                     BranchNameTemplate = branchNameTemplate
+                },
+                CommitSettings = new CommitSettings
+                {
+                    CommitMessagePrefix = commitMessagePrefix
                 }
             };
 

NuKeeper/Engine/DefaultCommitWorder.cs

@@ -34,14 +34,14 @@ private static string PackageTitle(PackageUpdateSet updates)
             return $"Automatic update of {updates.SelectedId} to {updates.SelectedVersion}";
         }
 
-        public string MakeCommitMessage(PackageUpdateSet updates)
+        public string MakeCommitMessage(PackageUpdateSet updates, string commitMessagePrefix)
         {
             if (updates == null)
             {
                 throw new ArgumentNullException(nameof(updates));
             }
 
-            return $":{CommitEmoji}: {PackageTitle(updates)}";
+            return $"{commitMessagePrefix}:{CommitEmoji}: {PackageTitle(updates)}";
         }
 
         public string MakeCommitDetails(IReadOnlyCollection<PackageUpdateSet> updates)

NuKeeper/Engine/Packages/ExistingCommitFilter.cs

@@ -20,7 +20,7 @@ public ExistingCommitFilter(ICollaborationFactory collaborationFactory, INuKeepe
             _logger = logger;
         }
 
-        public async Task<IReadOnlyCollection<PackageUpdateSet>> Filter(IGitDriver git, IReadOnlyCollection<PackageUpdateSet> updates, string baseBranch, string headBranch)
+        public async Task<IReadOnlyCollection<PackageUpdateSet>> Filter(IGitDriver git, IReadOnlyCollection<PackageUpdateSet> updates, string baseBranch, string headBranch, string commitMessagePrefix)
         {
             if (git == null)
             {
@@ -41,7 +41,7 @@ public async Task<IReadOnlyCollection<PackageUpdateSet>> Filter(IGitDriver git,
 
                 foreach (var update in updates)
                 {
-                    var updateCommitMessage = _collaborationFactory.CommitWorder.MakeCommitMessage(update);
+                    var updateCommitMessage = _collaborationFactory.CommitWorder.MakeCommitMessage(update, commitMessagePrefix);
                     var compactUpdateCommitMessage = new string(updateCommitMessage.Where(c => !char.IsWhiteSpace(c)).ToArray());
 
                     if (!compactCommitMessages.Contains(compactUpdateCommitMessage))

NuKeeper/Engine/Packages/IExistingCommitFilter.cs

@@ -11,6 +11,7 @@ Task<IReadOnlyCollection<PackageUpdateSet>> Filter(
             IGitDriver git,
             IReadOnlyCollection<PackageUpdateSet> updates,
             string baseBranch,
-            string headBranch);
+            string headBranch,
+            string commitMessagePrefix);
     }
 }

NuKeeper/Engine/Packages/PackageUpdater.cs

@@ -112,18 +112,18 @@ SettingsContainer settings
                 await git.CheckoutRemoteToLocal(branchWithChanges);
             }
 
-            var filteredUpdates = await _existingCommitFilter.Filter(git, updates, repository.DefaultBranch, branchWithChanges);
+            var filteredUpdates = await _existingCommitFilter.Filter(git, updates, repository.DefaultBranch, branchWithChanges, settings.CommitSettings.CommitMessagePrefix);
 
             foreach (var filtered in updates.Where(u => !filteredUpdates.Contains(u)))
             {
-                var commitMessage = _collaborationFactory.CommitWorder.MakeCommitMessage(filtered);
+                var commitMessage = _collaborationFactory.CommitWorder.MakeCommitMessage(filtered, settings.CommitSettings.CommitMessagePrefix);
                 _logger.Normal($"Commit '{commitMessage}' already in branch '{branchWithChanges}'");
             }
 
             var haveUpdates = filteredUpdates.Any();
             foreach (var updateSet in filteredUpdates)
             {
-                var commitMessage = _collaborationFactory.CommitWorder.MakeCommitMessage(updateSet);
+                var commitMessage = _collaborationFactory.CommitWorder.MakeCommitMessage(updateSet, settings.CommitSettings.CommitMessagePrefix);
 
                 await _updateRunner.Update(updateSet, sources);
 

Nukeeper.AzureDevOps.Tests/AzureDevOpsCommitWorderTests.cs

@@ -45,35 +45,35 @@ public void MakeCommitMessage_OneUpdateIsCorrect()
         {
             var updates = PackageUpdates.For(MakePackageForV110());
 
-            var report = _sut.MakeCommitMessage(updates);
+            var report = _sut.MakeCommitMessage(updates, "someprefix: ");
 
             Assert.That(report, Is.Not.Null);
             Assert.That(report, Is.Not.Empty);
-            Assert.That(report, Is.EqualTo($"{CommitEmoji} Automatic update of foo.bar to 1.2.3"));
+            Assert.That(report, Is.EqualTo($"someprefix: {CommitEmoji} Automatic update of foo.bar to 1.2.3"));
         }
 
         [Test]
         public void MakeCommitMessage_TwoUpdatesIsCorrect()
         {
             var updates = PackageUpdates.For(MakePackageForV110(), MakePackageForV100());
 
-            var report = _sut.MakeCommitMessage(updates);
+            var report = _sut.MakeCommitMessage(updates, "someprefix: ");
 
             Assert.That(report, Is.Not.Null);
             Assert.That(report, Is.Not.Empty);
-            Assert.That(report, Is.EqualTo($"{CommitEmoji} Automatic update of foo.bar to 1.2.3"));
+            Assert.That(report, Is.EqualTo($"someprefix: {CommitEmoji} Automatic update of foo.bar to 1.2.3"));
         }
 
         [Test]
         public void MakeCommitMessage_TwoUpdatesSameVersionIsCorrect()
         {
             var updates = PackageUpdates.For(MakePackageForV110(), MakePackageForV110InProject3());
 
-            var report = _sut.MakeCommitMessage(updates);
+            var report = _sut.MakeCommitMessage(updates, "someprefix: ");
 
             Assert.That(report, Is.Not.Null);
             Assert.That(report, Is.Not.Empty);
-            Assert.That(report, Is.EqualTo($"{CommitEmoji} Automatic update of foo.bar to 1.2.3"));
+            Assert.That(report, Is.EqualTo($"someprefix: {CommitEmoji} Automatic update of foo.bar to 1.2.3"));
         }
 
         [Test]