Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+128 −7
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions github/github-accessors.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

38 changes: 38 additions & 0 deletions github/github-accessors_test.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

36 changes: 29 additions & 7 deletions github/rules.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)
Comment on lines +138 to +139
Copy link
Contributor

@alexandear alexandear Nov 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

User is missing?

Suggested change
RulesetReviewerTypeTeam RulesetReviewerType = "Team"
)
RulesetReviewerTypeTeam RulesetReviewerType = "Team"
RulesetReviewerTypeUser RulesetReviewerType = "User"
)


// PatternRuleOperator models a GitHub pattern rule operator.
type PatternRuleOperator string

Expand Down Expand Up @@ -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.
Expand Down
29 changes: 29 additions & 0 deletions github/rules_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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{
Expand Down
Loading