Fix: Add RequiredSignatures to the BranchProtectionSettingsUpdate…

… Type (octokit#2873)

* fix: added `RequiredSignatures` to the `BranchProtectionSettingsUpdate` types.

- Fixes octokit#2855
- Updated `BranchProtectionSettingsUpdate` by adding `RequiredSignatures`.
- Update all integration `xUnit` tests to check for the `RequiredSignatures` property.

* docs: add comment documenting the `RequiredSignatures` property

Octokit.Tests.Integration/Helpers/OrganizationRepositoryWithTeamContext.cs

@@ -34,6 +34,7 @@ internal async static Task ProtectDefaultBranch(this IGitHubClient client, Repos
                 true,
                 true,
                 true,
+                true,
                 false,
                 true);
 
@@ -55,6 +56,8 @@ internal async static Task<RepositoryContext> CreateRepositoryWithProtectedBranc
                 true,
                 true,
                 true,
+                true,
+                true,
                 false,
                 true);
 

Octokit.Tests.Integration/Reactive/ObservableRepositoryBranchesClientTests.cs

@@ -191,6 +191,7 @@ public async Task UpdatesBranchProtectionForOrgRepo()
                         new BranchProtectionRequiredStatusChecksUpdate(false, new[] { "new" }),
                         new BranchProtectionRequiredReviewsUpdate(new BranchProtectionRequiredReviewsDismissalRestrictionsUpdate(false), false, false, 2),
                         new BranchProtectionPushRestrictionsUpdate(),
+                        true,
                         false,
                         true,
                         true,
@@ -211,6 +212,7 @@ public async Task UpdatesBranchProtectionForOrgRepo()
                     Assert.Empty(protection.Restrictions.Teams);
                     Assert.Empty(protection.Restrictions.Users);
 
+                    Assert.True(protection.RequiredSignatures.Enabled);
                     Assert.False(protection.EnforceAdmins.Enabled);
                     Assert.True(protection.RequiredLinearHistory.Enabled);
                     Assert.True(protection.AllowForcePushes.Enabled);
@@ -230,6 +232,7 @@ public async Task UpdatesBranchProtectionForOrgRepoWithRepositoryId()
                         new BranchProtectionRequiredStatusChecksUpdate(false, new[] { "new" }),
                         new BranchProtectionRequiredReviewsUpdate(new BranchProtectionRequiredReviewsDismissalRestrictionsUpdate(false), false, false, 2),
                         new BranchProtectionPushRestrictionsUpdate(),
+                        true,
                         false,
                         true,
                         true,
@@ -250,6 +253,7 @@ public async Task UpdatesBranchProtectionForOrgRepoWithRepositoryId()
                     Assert.Empty(protection.Restrictions.Teams);
                     Assert.Empty(protection.Restrictions.Users);
 
+                    Assert.True(protection.RequiredSignatures.Enabled);
                     Assert.False(protection.EnforceAdmins.Enabled);
                     Assert.True(protection.RequiredLinearHistory.Enabled);
                     Assert.True(protection.AllowForcePushes.Enabled);

Octokit/Models/Request/BranchProtectionUpdate.cs

@@ -112,6 +112,7 @@ public BranchProtectionSettingsUpdate(BranchProtectionRequiredStatusChecksUpdate
         /// <param name="requiredStatusChecks">Specifies the requested status check settings. Pass null to disable status checks</param>
         /// <param name="requiredPullRequestReviews">Specifies if reviews are required to merge the pull request. Pass null to disable required reviews</param>
         /// <param name="restrictions">Specifies the requested push access restrictions (applies only to Organization owned repositories). Pass null to disable push access restrictions</param>
+        /// <param name="requiredSignatures">Specifies whether commits to a branch are required to be signed by gpg keys</param>
         /// <param name="enforceAdmins">Specifies whether the protections applied to this branch also apply to repository admins</param>
         /// <param name="requiredLinearHistory">Enforces a linear commit Git history</param>
         /// <param name="allowForcePushes">Permits force pushes to the protected branch</param>
@@ -122,6 +123,7 @@ public BranchProtectionSettingsUpdate(BranchProtectionRequiredStatusChecksUpdate
         public BranchProtectionSettingsUpdate(BranchProtectionRequiredStatusChecksUpdate requiredStatusChecks,
                                               BranchProtectionRequiredReviewsUpdate requiredPullRequestReviews,
                                               BranchProtectionPushRestrictionsUpdate restrictions,
+                                              bool requiredSignatures,
                                               bool enforceAdmins,
                                               bool requiredLinearHistory,
                                               bool? allowForcePushes,
@@ -133,6 +135,7 @@ public BranchProtectionSettingsUpdate(BranchProtectionRequiredStatusChecksUpdate
             RequiredStatusChecks = requiredStatusChecks;
             RequiredPullRequestReviews = requiredPullRequestReviews;
             Restrictions = restrictions;
+            RequiredSignatures = requiredSignatures;
             EnforceAdmins = enforceAdmins;
             LockBranch = lockBranch;
             RequiredLinearHistory = requiredLinearHistory;
@@ -159,6 +162,11 @@ public BranchProtectionSettingsUpdate(BranchProtectionRequiredStatusChecksUpdate
         /// </summary>
         [SerializeNull]
         public BranchProtectionPushRestrictionsUpdate Restrictions { get; protected set; }
+
+        /// <summary>
+        /// Specifies whether the signed commits are required for this branch
+        /// </summary>
+        public bool RequiredSignatures { get; set; }
 
         /// <summary>
         /// Specifies whether the protections applied to this branch also apply to repository admins