Skip to content

Add support for required reviews in rulesets #3806

@sstrullmyer

Description

@sstrullmyer

GitHub announced support in rule sets for requiring team approvals prior to merging changes into protected branches. This seems like a useful feature to support in Terraform

Here is a sample portion of the API response for a ruleset with this configured (received via the Get a repository ruleset endpoint)

  "rules": [
    {
      "type": "pull_request",
      "parameters": {
        "required_approving_review_count": 0,
        "dismiss_stale_reviews_on_push": false,
        "required_reviewers": [
          {
            "minimum_approvals": 1,
            "file_patterns": [
              "*"
            ],
            "reviewer": {
              "id": 123456,
              "type": "Team"
            }
          }
        ],
        "require_code_owner_review": false,
        "require_last_push_approval": false,
        "required_review_thread_resolution": false,
        "automatic_copilot_code_review_enabled": false,
        "allowed_merge_methods": [
          "merge",
          "squash",
          "rebase"
        ]
      }
    }
  ]

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions