Obsolete repo.Commit() overloads that do not require Signature parameters

Author: nulltoken

LibGit2Sharp.Tests/CommitFixture.cs

@@ -560,7 +560,9 @@ public void CanCommitWithSignatureFromConfig()
 
                 Assert.Null(repo.Head[relativeFilepath]);
 
-                Commit commit = repo.Commit("Initial egotistic commit");
+                Signature signature = repo.Config.BuildSignature(DateTimeOffset.Now);
+
+                Commit commit = repo.Commit("Initial egotistic commit", signature, signature);
 
                 AssertBlobContent(repo.Head[relativeFilepath], "nulltoken\n");
                 AssertBlobContent(commit[relativeFilepath], "nulltoken\n");

LibGit2Sharp.Tests/FilterFixture.cs

@@ -159,7 +159,7 @@ public void CleanFilterWritesOutputToObjectTree()
                 using (var repo = CreateTestRepository(repoPath))
                 {
                     FileInfo expectedFile = StageNewFile(repo, decodedInput);
-                    var commit = repo.Commit("Clean that file");
+                    var commit = repo.Commit("Clean that file", Constants.Signature, Constants.Signature);
                     var blob = (Blob)commit.Tree[expectedFile.Name].Target;
 
                     var textDetected = blob.GetContentText();
@@ -240,7 +240,7 @@ public void CanFilterLargeFiles()
                     File.WriteAllText(attributesPath, "*.blob filter=test");
                     repo.Stage(attributesFile.Name);
                     repo.Stage(contentFile.Name);
-                    repo.Commit("test");
+                    repo.Commit("test", Constants.Signature, Constants.Signature);
                     contentFile.Delete();
                     repo.Checkout("HEAD", new CheckoutOptions() { CheckoutModifiers = CheckoutModifiers.Force });
                 }
@@ -346,7 +346,7 @@ private FileInfo CheckoutFileForSmudge(string repoPath, string branchName, strin
             {
                 StageNewFile(repo, content);
 
-                repo.Commit("Initial commit");
+                repo.Commit("Initial commit", Constants.Signature, Constants.Signature);
 
                 expectedPath = CommitFileOnBranch(repo, branchName, content);
 
@@ -363,7 +363,7 @@ private static FileInfo CommitFileOnBranch(Repository repo, string branchName, S
             repo.Checkout(branch.FriendlyName);
 
             FileInfo expectedPath = StageNewFile(repo, content);
-            repo.Commit("Commit");
+            repo.Commit("Commit", Constants.Signature, Constants.Signature);
             return expectedPath;
         }
 

LibGit2Sharp.Tests/FilterSubstitutionCipherFixture.cs

@@ -203,15 +203,15 @@ private static void DeleteFile(Repository repo, string fileName)
         {
             File.Delete(Path.Combine(repo.Info.WorkingDirectory, fileName));
             repo.Stage(fileName);
-            repo.Commit("remove file");
+            repo.Commit("remove file", Constants.Signature, Constants.Signature);
         }
 
         private static Blob CommitOnBranchAndReturnDatabaseBlob(Repository repo, string fileName, string input)
         {
             Touch(repo.Info.WorkingDirectory, fileName, input);
             repo.Stage(fileName);
 
-            var commit = repo.Commit("new file");
+            var commit = repo.Commit("new file", Constants.Signature, Constants.Signature);
 
             var blob = (Blob)commit.Tree[fileName].Target;
             return blob;

LibGit2Sharp/RepositoryExtensions.cs

@@ -219,6 +219,7 @@ private static Commit LookUpCommit(IRepository repository, string committish)
         /// <param name="repository">The <see cref="Repository"/> being worked with.</param>
         /// <param name="message">The description of why a change was made to the repository.</param>
         /// <returns>The generated <see cref="LibGit2Sharp.Commit"/>.</returns>
+        [Obsolete("This method will be removed in the next release. Please use Commit(string, Signature, Signature) instead.")]
         public static Commit Commit(this IRepository repository, string message)
         {
             return repository.Commit(message, (CommitOptions)null);
@@ -234,6 +235,7 @@ public static Commit Commit(this IRepository repository, string message)
         /// <param name="message">The description of why a change was made to the repository.</param>
         /// <param name="options">The <see cref="CommitOptions"/> that specify the commit behavior.</param>
         /// <returns>The generated <see cref="LibGit2Sharp.Commit"/>.</returns>
+        [Obsolete("This method will be removed in the next release. Please use Commit(string, Signature, Signature, CommitOptions) instead.")]
         public static Commit Commit(this IRepository repository, string message, CommitOptions options)
         {
             Signature author = repository.Config.BuildSignatureOrThrow(DateTimeOffset.Now);
@@ -251,6 +253,7 @@ public static Commit Commit(this IRepository repository, string message, CommitO
         /// <param name="author">The <see cref="Signature"/> of who made the change.</param>
         /// <param name="message">The description of why a change was made to the repository.</param>
         /// <returns>The generated <see cref="LibGit2Sharp.Commit"/>.</returns>
+        [Obsolete("This method will be removed in the next release. Please use Commit(string, Signature, Signature) instead.")]
         public static Commit Commit(this IRepository repository, string message, Signature author)
         {
             return repository.Commit(message, author, (CommitOptions)null);
@@ -267,13 +270,29 @@ public static Commit Commit(this IRepository repository, string message, Signatu
         /// <param name="message">The description of why a change was made to the repository.</param>
         /// <param name="options">The <see cref="CommitOptions"/> that specify the commit behavior.</param>
         /// <returns>The generated <see cref="LibGit2Sharp.Commit"/>.</returns>
+        [Obsolete("This method will be removed in the next release. Please use Commit(string, Signature, Signature, CommitOptions) instead.")]
         public static Commit Commit(this IRepository repository, string message, Signature author, CommitOptions options)
         {
             Signature committer = repository.Config.BuildSignatureOrThrow(DateTimeOffset.Now);
 
             return repository.Commit(message, author, committer, options);
         }
 
+        /// <summary>
+        /// Stores the content of the <see cref="Repository.Index"/> as a new <see cref="LibGit2Sharp.Commit"/> into the repository.
+        /// The tip of the <see cref="Repository.Head"/> will be used as the parent of this new Commit.
+        /// Once the commit is created, the <see cref="Repository.Head"/> will move forward to point at it.
+        /// </summary>
+        /// <param name="repository">The <see cref="IRepository"/> being worked with.</param>
+        /// <param name="message">The description of why a change was made to the repository.</param>
+        /// <param name="author">The <see cref="Signature"/> of who made the change.</param>
+        /// <param name="committer">The <see cref="Signature"/> of who added the change to the repository.</param>
+        /// <returns>The generated <see cref="LibGit2Sharp.Commit"/>.</returns>
+        public static Commit Commit(this IRepository repository, string message, Signature author, Signature committer)
+        {
+            return repository.Commit(message, author, committer, default(CommitOptions));
+        }
+
         /// <summary>
         /// Fetch from the specified remote.
         /// </summary>
@@ -601,21 +620,6 @@ public static void Reset(this IRepository repository, Commit commit)
             repository.Index.Replace(commit, null, null);
         }
 
-        /// <summary>
-        /// Stores the content of the <see cref="Repository.Index"/> as a new <see cref="LibGit2Sharp.Commit"/> into the repository.
-        /// The tip of the <see cref="Repository.Head"/> will be used as the parent of this new Commit.
-        /// Once the commit is created, the <see cref="Repository.Head"/> will move forward to point at it.
-        /// </summary>
-        /// <param name="repository">The <see cref="IRepository"/> being worked with.</param>
-        /// <param name="message">The description of why a change was made to the repository.</param>
-        /// <param name="author">The <see cref="Signature"/> of who made the change.</param>
-        /// <param name="committer">The <see cref="Signature"/> of who added the change to the repository.</param>
-        /// <returns>The generated <see cref="LibGit2Sharp.Commit"/>.</returns>
-        public static Commit Commit(this IRepository repository, string message, Signature author, Signature committer)
-        {
-            return repository.Commit(message, author, committer, null);
-        }
-
         /// <summary>
         /// Find where each line of a file originated.
         /// </summary>