[feat]: Add RenameBranch method to RepositoryBranchesClient

Octokit.Reactive/Clients/IObservableRepositoryBranchesClient.cs

@@ -1,15 +1,14 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
-
 namespace Octokit.Reactive
 {
-    /// <summary>
-    /// A client for GitHub's Repository Branches API.
-    /// </summary>
-    /// <remarks>
-    /// See the <a href="https://developer.github.com/v3/repos/branches">Repository Branches API documentation</a> for more details.
-    /// </remarks>
+	/// <summary>
+	/// A client for GitHub's Repository Branches API.
+	/// </summary>
+	/// <remarks>
+	/// See the <a href="https://developer.github.com/v3/repos/branches">Repository Branches API documentation</a> for more details.
+	/// </remarks>
     public interface IObservableRepositoryBranchesClient
     {
         /// <summary>
@@ -644,5 +643,17 @@ public interface IObservableRepositoryBranchesClient
         /// <param name="branch">The name of the branch</param>
         /// <param name="users">List of users with push access to remove</param>
         IObservable<User> DeleteProtectedBranchUserRestrictions(long repositoryId, string branch, BranchProtectionUserCollection users);
-    }
+
+		/// <summary>
+		/// Renames a branch in a repository
+		/// </summary>
+		/// <remarks>
+		/// See the <a href="https://docs.github.com/en/rest/branches/branches?apiVersion=2022-11-28#rename-a-branch">API documentation</a> for more details
+		/// </remarks>
+		/// <param name="owner">The owner of the repository</param>
+		/// <param name="repository">The name of the repository</param>
+		/// <param name="branch">The name of the branch to rename</param>
+		/// <param name="newName">The new name of the branch</param>
+		IObservable<Branch> RenameBranch(string owner, string repository, string branch, string newName);
+	}
 }

Octokit.Reactive/Clients/ObservableRepositoryBranchesClient.cs

@@ -3,6 +3,8 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Reactive.Linq;
 using System.Reactive.Threading.Tasks;
+using System.Threading.Tasks;
+
 using Octokit.Reactive.Internal;
 
 namespace Octokit.Reactive
@@ -1021,5 +1023,25 @@ public IObservable<User> DeleteProtectedBranchUserRestrictions(long repositoryId
 
             return _client.DeleteProtectedBranchUserRestrictions(repositoryId, branch, users).ToObservable().SelectMany(x => x);
         }
-    }
+
+		/// <summary>
+		/// Renames a branch in a repository
+		/// </summary>
+		/// <remarks>
+		/// See the <a href="https://docs.github.com/en/rest/branches/branches?apiVersion=2022-11-28#rename-a-branch">API documentation</a> for more details
+		/// </remarks>
+		/// <param name="owner">The owner of the repository</param>
+		/// <param name="repository">The name of the repository</param>
+		/// <param name="branch">The name of the branch to rename</param>
+		/// <param name="newName">The new name of the branch</param>
+		public IObservable<Branch> RenameBranch(string owner, string repository, string branch, string newName)
+		{
+			Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
+			Ensure.ArgumentNotNullOrEmptyString(repository, nameof(repository));
+			Ensure.ArgumentNotNullOrEmptyString(branch, nameof(branch));
+			Ensure.ArgumentNotNullOrEmptyString(newName, nameof(newName));
+
+			return _client.RenameBranch(owner, repository, branch, newName).ToObservable();
+		}
+	}
 }

Octokit.Tests/Clients/RepositoryBranchesClientTests.cs

@@ -1399,5 +1399,51 @@ public async Task EnsuresNonNullArguments()
                 await Assert.ThrowsAsync<ArgumentException>(() => client.DeleteProtectedBranchUserRestrictions(1, "", usersToRemove));
             }
         }
-    }
+
+		public class TheRenameBranchMethod
+		{
+			[Fact]
+			public void RequestsTheCorrectUrl()
+			{
+				var connection = Substitute.For<IApiConnection>();
+				var client = new RepositoryBranchesClient(connection);
+
+				client.RenameBranch("owner", "repo", "branch", "new_name");
+
+				connection.Received()
+					.Post<Branch>(Arg.Is<Uri>(u => u.ToString() == "repos/owner/repo/branches/branch/rename"), Arg.Any<object>());
+			}
+
+
+			[Fact]
+			public async Task PassesTheCorrectNewBranchParameter()
+			{
+				var connection = Substitute.For<IApiConnection>();
+				var client = new RepositoryBranchesClient(connection);
+				var newBranch = "a";
+
+				await client.RenameBranch("owner", "repo", "branch", newBranch);
+
+				connection.Received().Post<Branch>(
+					Arg.Any<Uri>(),
+					Arg.Is<object>(o => o.GetType().GetProperty("new_name").GetValue(o).ToString() == newBranch));
+			}
+
+			[Fact]
+			public async Task EnsuresNonNullArguments()
+			{
+				var client = new RepositoryBranchesClient(Substitute.For<IApiConnection>());
+
+				await Assert.ThrowsAsync<ArgumentNullException>(() => client.RenameBranch(null, "repo", "branch", "new_name"));
+				await Assert.ThrowsAsync<ArgumentNullException>(() => client.RenameBranch("owner", null, "branch", "new_name"));
+				await Assert.ThrowsAsync<ArgumentNullException>(() => client.RenameBranch("owner", "repo", null, "new_name"));
+				await Assert.ThrowsAsync<ArgumentNullException>(() => client.RenameBranch("owner", "repo", "branch", null));
+
+				await Assert.ThrowsAsync<ArgumentException>(() => client.RenameBranch("", "repo", "branch", "new_name"));
+				await Assert.ThrowsAsync<ArgumentException>(() => client.RenameBranch("owner", "", "branch", "new_name"));
+				await Assert.ThrowsAsync<ArgumentException>(() => client.RenameBranch("owner", "repo", "", "new_name"));
+				await Assert.ThrowsAsync<ArgumentException>(() => client.RenameBranch("owner", "repo", "branch", ""));
+			}
+		}
+	}
 }

Octokit/Clients/IRepositoryBranchesClient.cs

@@ -652,5 +652,17 @@ public interface IRepositoryBranchesClient
         /// <param name="branch">The name of the branch</param>
         /// <param name="users">List of users with push access to remove</param>
         Task<IReadOnlyList<User>> DeleteProtectedBranchUserRestrictions(long repositoryId, string branch, BranchProtectionUserCollection users);
+
+		/// <summary>
+		/// Renames a branch in a repository
+		/// </summary>
+		/// <remarks>
+		/// See the <a href="https://docs.github.com/en/rest/branches/branches?apiVersion=2022-11-28#rename-a-branch">API documentation</a> for more details
+		/// </remarks>
+		/// <param name="owner">The owner of the repository</param>
+		/// <param name="repository">The name of the repository</param>
+		/// <param name="branch">The name of the branch to rename</param>
+		/// <param name="newName">The new name of the branch</param>
+		Task<Branch> RenameBranch(string owner, string repository, string branch, string newName);
     }
 }

Octokit/Clients/RepositoryBranchesClient.cs

@@ -1,15 +1,14 @@
 using System.Collections.Generic;
 using System.Net;
 using System.Threading.Tasks;
-
 namespace Octokit
 {
-    /// <summary>
-    /// A client for GitHub's Repository Branches API.
-    /// </summary>
-    /// <remarks>
-    /// See the <a href="https://developer.github.com/v3/repos/branches">Repository Branches API documentation</a> for more details.
-    /// </remarks>
+	/// <summary>
+	/// A client for GitHub's Repository Branches API.
+	/// </summary>
+	/// <remarks>
+	/// See the <a href="https://developer.github.com/v3/repos/branches">Repository Branches API documentation</a> for more details.
+	/// </remarks>
     public class RepositoryBranchesClient : ApiClient, IRepositoryBranchesClient
     {
         /// <summary>
@@ -1177,5 +1176,26 @@ public Task<IReadOnlyList<User>> DeleteProtectedBranchUserRestrictions(long repo
 
             return ApiConnection.Delete<IReadOnlyList<User>>(ApiUrls.RepoRestrictionsUsers(repositoryId, branch), users);
         }
+
+		/// <summary>
+		/// Renames a branch in a repository
+		/// </summary>
+		/// <remarks>
+		/// See the <a href="https://docs.github.com/en/rest/branches/branches?apiVersion=2022-11-28#rename-a-branch">API documentation</a> for more details
+		/// </remarks>
+		/// <param name="owner">The owner of the repository</param>
+		/// <param name="repository">The name of the repository</param>
+		/// <param name="branch">The name of the branch to rename</param>
+		/// <param name="newName">The new name of the branch</param>
+		[ManualRoute("POST", "/repos/{owner}/{repo}/branches/{branch}/rename")]
+        public Task<Branch> RenameBranch(string owner, string repository, string branch, string newName)
+        {
+			Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
+			Ensure.ArgumentNotNullOrEmptyString(repository, nameof(repository));
+			Ensure.ArgumentNotNullOrEmptyString(branch, nameof(branch));
+			Ensure.ArgumentNotNullOrEmptyString(newName, nameof(newName));
+
+            return ApiConnection.Post<Branch>(ApiUrls.RepositoryBranchRename(owner, repository, branch), new { new_name = newName });
+		}
     }
 }

Octokit/Helpers/ApiUrls.cs

@@ -5553,6 +5553,18 @@ public static Uri DownloadArtifact(string owner, string repository, long artifac
         public static Uri ListWorkflowArtifacts(string owner, string repository, long runId)
         {
             return "repos/{0}/{1}/actions/runs/{2}/artifacts".FormatUri(owner, repository, runId);
+        }
+
+		/// <summary>
+		/// Returns the <see cref="Uri"/> to rename a repository branch.
+		/// </summary>
+		/// <param name="owner">The owner of the repository</param>
+		/// <param name="repository">The name of the repository</param>
+		/// <param name="branch">The name of the branch to rename</param>
+		/// <returns></returns>
+		public static Uri RepositoryBranchRename(string owner, string repository, string branch)
+        {
+            return "repos/{0}/{1}/branches/{2}/rename".FormatUri(owner, repository, branch);
         }
     }
 }

build/Utilities/BuildVersion.cs

@@ -45,7 +45,7 @@ public static BuildVersion Calculate(Context context)
 
         // Run in interactive mode to get the properties for the rest of the script
         var assertedversions = GitVersionRunner.Run(context, GitVersionOutput.Json);
-        
+
         version = assertedversions.MajorMinorPatch;
         semVersion = assertedversions.LegacySemVerPadded;
         fullSemVer = assertedversions.FullSemVer;