feat: Add required_reviewers support to PullRequestRuleParameters (#3806) (#3811)

Author: smazmi

github/github-accessors.go

@@ -130,6 +130,14 @@ const (
 	MergeQueueMergeMethodSquash MergeQueueMergeMethod = "SQUASH"
 )
 
+// RulesetReviewerType represents the type of reviewer in a ruleset required reviewer.
+type RulesetReviewerType string
+
+// This is the set of GitHub ruleset reviewer types.
+const (
+	RulesetReviewerTypeTeam RulesetReviewerType = "Team"
+)
+
 // PatternRuleOperator models a GitHub pattern rule operator.
 type PatternRuleOperator string
 
@@ -416,13 +424,27 @@ type RequiredDeploymentsRuleParameters struct {
 
 // PullRequestRuleParameters represents the pull_request rule parameters.
 type PullRequestRuleParameters struct {
-	AllowedMergeMethods               []PullRequestMergeMethod `json:"allowed_merge_methods"`
-	AutomaticCopilotCodeReviewEnabled *bool                    `json:"automatic_copilot_code_review_enabled,omitempty"`
-	DismissStaleReviewsOnPush         bool                     `json:"dismiss_stale_reviews_on_push"`
-	RequireCodeOwnerReview            bool                     `json:"require_code_owner_review"`
-	RequireLastPushApproval           bool                     `json:"require_last_push_approval"`
-	RequiredApprovingReviewCount      int                      `json:"required_approving_review_count"`
-	RequiredReviewThreadResolution    bool                     `json:"required_review_thread_resolution"`
+	AllowedMergeMethods               []PullRequestMergeMethod   `json:"allowed_merge_methods"`
+	AutomaticCopilotCodeReviewEnabled *bool                      `json:"automatic_copilot_code_review_enabled,omitempty"`
+	DismissStaleReviewsOnPush         bool                       `json:"dismiss_stale_reviews_on_push"`
+	RequireCodeOwnerReview            bool                       `json:"require_code_owner_review"`
+	RequireLastPushApproval           bool                       `json:"require_last_push_approval"`
+	RequiredApprovingReviewCount      int                        `json:"required_approving_review_count"`
+	RequiredReviewers                 []*RulesetRequiredReviewer `json:"required_reviewers,omitempty"`
+	RequiredReviewThreadResolution    bool                       `json:"required_review_thread_resolution"`
+}
+
+// RulesetRequiredReviewer represents required reviewer parameters for pull requests in rulesets.
+type RulesetRequiredReviewer struct {
+	MinimumApprovals *int             `json:"minimum_approvals,omitempty"`
+	FilePatterns     []string         `json:"file_patterns,omitempty"`
+	Reviewer         *RulesetReviewer `json:"reviewer,omitempty"`
+}
+
+// RulesetReviewer represents a reviewer in a ruleset required reviewer rule.
+type RulesetReviewer struct {
+	ID   *int64               `json:"id,omitempty"`
+	Type *RulesetReviewerType `json:"type,omitempty"`
 }
 
 // RequiredStatusChecksRuleParameters represents the required status checks rule parameters.

github/github-accessors_test.go

@@ -736,6 +736,35 @@ func TestRepositoryRule(t *testing.T) {
 			},
 			`{"type":"pull_request","parameters":{"allowed_merge_methods":["squash","rebase"],"automatic_copilot_code_review_enabled": true,"dismiss_stale_reviews_on_push":true,"require_code_owner_review":true,"require_last_push_approval":true,"required_approving_review_count":2,"required_review_thread_resolution":true}}`,
 		},
+		{
+			"pull_request_with_required_reviewers",
+			&RepositoryRule{
+				Type: RulesetRuleTypePullRequest,
+				Parameters: &PullRequestRuleParameters{
+					AllowedMergeMethods: []PullRequestMergeMethod{
+						PullRequestMergeMethodMerge,
+						PullRequestMergeMethodSquash,
+						PullRequestMergeMethodRebase,
+					},
+					DismissStaleReviewsOnPush:      false,
+					RequireCodeOwnerReview:         false,
+					RequireLastPushApproval:        false,
+					RequiredApprovingReviewCount:   0,
+					RequiredReviewThreadResolution: false,
+					RequiredReviewers: []*RulesetRequiredReviewer{
+						{
+							MinimumApprovals: Ptr(1),
+							FilePatterns:     []string{"*"},
+							Reviewer: &RulesetReviewer{
+								ID:   Ptr(int64(123456)),
+								Type: Ptr(RulesetReviewerTypeTeam),
+							},
+						},
+					},
+				},
+			},
+			`{"type":"pull_request","parameters":{"allowed_merge_methods":["merge","squash","rebase"],"dismiss_stale_reviews_on_push":false,"require_code_owner_review":false,"require_last_push_approval":false,"required_approving_review_count":0,"required_reviewers":[{"minimum_approvals":1,"file_patterns":["*"],"reviewer":{"id":123456,"type":"Team"}}],"required_review_thread_resolution":false}}`,
+		},
 		{
 			"required_status_checks",
 			&RepositoryRule{