Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Github Provider
  3. API Docs
  4. OrganizationRuleset
GitHub v6.7.0 published on Friday, Feb 28, 2025 by Pulumi
pulumi/pulumi-github

github.OrganizationRuleset

Explore with Pulumi AI

github logo
GitHub v6.7.0 published on Friday, Feb 28, 2025 by Pulumi
pulumi/pulumi-github

    Creates a GitHub organization ruleset.

    This resource allows you to create and manage rulesets on the organization level. When applied, a new ruleset will be created. When destroyed, that ruleset will be removed.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";

const example = new github.OrganizationRuleset("example", {
    name: "example",
    target: "branch",
    enforcement: "active",
    conditions: {
        refName: {
            includes: ["~ALL"],
            excludes: [],
        },
    },
    bypassActors: [{
        actorId: 13473,
        actorType: "Integration",
        bypassMode: "always",
    }],
    rules: {
        creation: true,
        update: true,
        deletion: true,
        requiredLinearHistory: true,
        requiredSignatures: true,
        branchNamePattern: {
            name: "example",
            negate: false,
            operator: "starts_with",
            pattern: "ex",
        },
    },
});

    import pulumi
import pulumi_github as github

example = github.OrganizationRuleset("example",
    name="example",
    target="branch",
    enforcement="active",
    conditions={
        "ref_name": {
            "includes": ["~ALL"],
            "excludes": [],
        },
    },
    bypass_actors=[{
        "actor_id": 13473,
        "actor_type": "Integration",
        "bypass_mode": "always",
    }],
    rules={
        "creation": True,
        "update": True,
        "deletion": True,
        "required_linear_history": True,
        "required_signatures": True,
        "branch_name_pattern": {
            "name": "example",
            "negate": False,
            "operator": "starts_with",
            "pattern": "ex",
        },
    })

    package main

import (
	"github.com/pulumi/pulumi-github/sdk/v6/go/github"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := github.NewOrganizationRuleset(ctx, "example", &github.OrganizationRulesetArgs{
			Name:        pulumi.String("example"),
			Target:      pulumi.String("branch"),
			Enforcement: pulumi.String("active"),
			Conditions: &github.OrganizationRulesetConditionsArgs{
				RefName: &github.OrganizationRulesetConditionsRefNameArgs{
					Includes: pulumi.StringArray{
						pulumi.String("~ALL"),
					},
					Excludes: pulumi.StringArray{},
				},
			},
			BypassActors: github.OrganizationRulesetBypassActorArray{
				&github.OrganizationRulesetBypassActorArgs{
					ActorId:    pulumi.Int(13473),
					ActorType:  pulumi.String("Integration"),
					BypassMode: pulumi.String("always"),
				},
			},
			Rules: &github.OrganizationRulesetRulesArgs{
				Creation:              pulumi.Bool(true),
				Update:                pulumi.Bool(true),
				Deletion:              pulumi.Bool(true),
				RequiredLinearHistory: pulumi.Bool(true),
				RequiredSignatures:    pulumi.Bool(true),
				BranchNamePattern: &github.OrganizationRulesetRulesBranchNamePatternArgs{
					Name:     pulumi.String("example"),
					Negate:   pulumi.Bool(false),
					Operator: pulumi.String("starts_with"),
					Pattern:  pulumi.String("ex"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;

return await Deployment.RunAsync(() => 
{
    var example = new Github.OrganizationRuleset("example", new()
    {
        Name = "example",
        Target = "branch",
        Enforcement = "active",
        Conditions = new Github.Inputs.OrganizationRulesetConditionsArgs
        {
            RefName = new Github.Inputs.OrganizationRulesetConditionsRefNameArgs
            {
                Includes = new[]
                {
                    "~ALL",
                },
                Excludes = new() { },
            },
        },
        BypassActors = new[]
        {
            new Github.Inputs.OrganizationRulesetBypassActorArgs
            {
                ActorId = 13473,
                ActorType = "Integration",
                BypassMode = "always",
            },
        },
        Rules = new Github.Inputs.OrganizationRulesetRulesArgs
        {
            Creation = true,
            Update = true,
            Deletion = true,
            RequiredLinearHistory = true,
            RequiredSignatures = true,
            BranchNamePattern = new Github.Inputs.OrganizationRulesetRulesBranchNamePatternArgs
            {
                Name = "example",
                Negate = false,
                Operator = "starts_with",
                Pattern = "ex",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.OrganizationRuleset;
import com.pulumi.github.OrganizationRulesetArgs;
import com.pulumi.github.inputs.OrganizationRulesetConditionsArgs;
import com.pulumi.github.inputs.OrganizationRulesetConditionsRefNameArgs;
import com.pulumi.github.inputs.OrganizationRulesetBypassActorArgs;
import com.pulumi.github.inputs.OrganizationRulesetRulesArgs;
import com.pulumi.github.inputs.OrganizationRulesetRulesBranchNamePatternArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new OrganizationRuleset("example", OrganizationRulesetArgs.builder()
            .name("example")
            .target("branch")
            .enforcement("active")
            .conditions(OrganizationRulesetConditionsArgs.builder()
                .refName(OrganizationRulesetConditionsRefNameArgs.builder()
                    .includes("~ALL")
                    .excludes()
                    .build())
                .build())
            .bypassActors(OrganizationRulesetBypassActorArgs.builder()
                .actorId(13473)
                .actorType("Integration")
                .bypassMode("always")
                .build())
            .rules(OrganizationRulesetRulesArgs.builder()
                .creation(true)
                .update(true)
                .deletion(true)
                .requiredLinearHistory(true)
                .requiredSignatures(true)
                .branchNamePattern(OrganizationRulesetRulesBranchNamePatternArgs.builder()
                    .name("example")
                    .negate(false)
                    .operator("starts_with")
                    .pattern("ex")
                    .build())
                .build())
            .build());

    }
}

    resources:
  example:
    type: github:OrganizationRuleset
    properties:
      name: example
      target: branch
      enforcement: active
      conditions:
        refName:
          includes:
            - ~ALL
          excludes: []
      bypassActors:
        - actorId: 13473
          actorType: Integration
          bypassMode: always
      rules:
        creation: true
        update: true
        deletion: true
        requiredLinearHistory: true
        requiredSignatures: true
        branchNamePattern:
          name: example
          negate: false
          operator: starts_with
          pattern: ex

    Create OrganizationRuleset Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OrganizationRuleset(name: string, args: OrganizationRulesetArgs, opts?: CustomResourceOptions);
    @overload
def OrganizationRuleset(resource_name: str,
                        args: OrganizationRulesetArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def OrganizationRuleset(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        enforcement: Optional[str] = None,
                        rules: Optional[OrganizationRulesetRulesArgs] = None,
                        target: Optional[str] = None,
                        bypass_actors: Optional[Sequence[OrganizationRulesetBypassActorArgs]] = None,
                        conditions: Optional[OrganizationRulesetConditionsArgs] = None,
                        name: Optional[str] = None)
    func NewOrganizationRuleset(ctx *Context, name string, args OrganizationRulesetArgs, opts ...ResourceOption) (*OrganizationRuleset, error)
    public OrganizationRuleset(string name, OrganizationRulesetArgs args, CustomResourceOptions? opts = null)
    public OrganizationRuleset(String name, OrganizationRulesetArgs args)
public OrganizationRuleset(String name, OrganizationRulesetArgs args, CustomResourceOptions options)

    type: github:OrganizationRuleset
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OrganizationRulesetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OrganizationRulesetArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OrganizationRulesetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationRulesetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationRulesetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var organizationRulesetResource = new Github.OrganizationRuleset("organizationRulesetResource", new()
{
    Enforcement = "string",
    Rules = new Github.Inputs.OrganizationRulesetRulesArgs
    {
        BranchNamePattern = new Github.Inputs.OrganizationRulesetRulesBranchNamePatternArgs
        {
            Operator = "string",
            Pattern = "string",
            Name = "string",
            Negate = false,
        },
        CommitAuthorEmailPattern = new Github.Inputs.OrganizationRulesetRulesCommitAuthorEmailPatternArgs
        {
            Operator = "string",
            Pattern = "string",
            Name = "string",
            Negate = false,
        },
        CommitMessagePattern = new Github.Inputs.OrganizationRulesetRulesCommitMessagePatternArgs
        {
            Operator = "string",
            Pattern = "string",
            Name = "string",
            Negate = false,
        },
        CommitterEmailPattern = new Github.Inputs.OrganizationRulesetRulesCommitterEmailPatternArgs
        {
            Operator = "string",
            Pattern = "string",
            Name = "string",
            Negate = false,
        },
        Creation = false,
        Deletion = false,
        NonFastForward = false,
        PullRequest = new Github.Inputs.OrganizationRulesetRulesPullRequestArgs
        {
            DismissStaleReviewsOnPush = false,
            RequireCodeOwnerReview = false,
            RequireLastPushApproval = false,
            RequiredApprovingReviewCount = 0,
            RequiredReviewThreadResolution = false,
        },
        RequiredCodeScanning = new Github.Inputs.OrganizationRulesetRulesRequiredCodeScanningArgs
        {
            RequiredCodeScanningTools = new[]
            {
                new Github.Inputs.OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolArgs
                {
                    AlertsThreshold = "string",
                    SecurityAlertsThreshold = "string",
                    Tool = "string",
                },
            },
        },
        RequiredLinearHistory = false,
        RequiredSignatures = false,
        RequiredStatusChecks = new Github.Inputs.OrganizationRulesetRulesRequiredStatusChecksArgs
        {
            RequiredChecks = new[]
            {
                new Github.Inputs.OrganizationRulesetRulesRequiredStatusChecksRequiredCheckArgs
                {
                    Context = "string",
                    IntegrationId = 0,
                },
            },
            StrictRequiredStatusChecksPolicy = false,
        },
        RequiredWorkflows = new Github.Inputs.OrganizationRulesetRulesRequiredWorkflowsArgs
        {
            RequiredWorkflows = new[]
            {
                new Github.Inputs.OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowArgs
                {
                    Path = "string",
                    RepositoryId = 0,
                    Ref = "string",
                },
            },
        },
        TagNamePattern = new Github.Inputs.OrganizationRulesetRulesTagNamePatternArgs
        {
            Operator = "string",
            Pattern = "string",
            Name = "string",
            Negate = false,
        },
        Update = false,
    },
    Target = "string",
    BypassActors = new[]
    {
        new Github.Inputs.OrganizationRulesetBypassActorArgs
        {
            ActorId = 0,
            ActorType = "string",
            BypassMode = "string",
        },
    },
    Conditions = new Github.Inputs.OrganizationRulesetConditionsArgs
    {
        RefName = new Github.Inputs.OrganizationRulesetConditionsRefNameArgs
        {
            Excludes = new[]
            {
                "string",
            },
            Includes = new[]
            {
                "string",
            },
        },
        RepositoryIds = new[]
        {
            0,
        },
        RepositoryName = new Github.Inputs.OrganizationRulesetConditionsRepositoryNameArgs
        {
            Excludes = new[]
            {
                "string",
            },
            Includes = new[]
            {
                "string",
            },
            Protected = false,
        },
    },
    Name = "string",
});

    example, err := github.NewOrganizationRuleset(ctx, "organizationRulesetResource", &github.OrganizationRulesetArgs{
	Enforcement: pulumi.String("string"),
	Rules: &github.OrganizationRulesetRulesArgs{
		BranchNamePattern: &github.OrganizationRulesetRulesBranchNamePatternArgs{
			Operator: pulumi.String("string"),
			Pattern:  pulumi.String("string"),
			Name:     pulumi.String("string"),
			Negate:   pulumi.Bool(false),
		},
		CommitAuthorEmailPattern: &github.OrganizationRulesetRulesCommitAuthorEmailPatternArgs{
			Operator: pulumi.String("string"),
			Pattern:  pulumi.String("string"),
			Name:     pulumi.String("string"),
			Negate:   pulumi.Bool(false),
		},
		CommitMessagePattern: &github.OrganizationRulesetRulesCommitMessagePatternArgs{
			Operator: pulumi.String("string"),
			Pattern:  pulumi.String("string"),
			Name:     pulumi.String("string"),
			Negate:   pulumi.Bool(false),
		},
		CommitterEmailPattern: &github.OrganizationRulesetRulesCommitterEmailPatternArgs{
			Operator: pulumi.String("string"),
			Pattern:  pulumi.String("string"),
			Name:     pulumi.String("string"),
			Negate:   pulumi.Bool(false),
		},
		Creation:       pulumi.Bool(false),
		Deletion:       pulumi.Bool(false),
		NonFastForward: pulumi.Bool(false),
		PullRequest: &github.OrganizationRulesetRulesPullRequestArgs{
			DismissStaleReviewsOnPush:      pulumi.Bool(false),
			RequireCodeOwnerReview:         pulumi.Bool(false),
			RequireLastPushApproval:        pulumi.Bool(false),
			RequiredApprovingReviewCount:   pulumi.Int(0),
			RequiredReviewThreadResolution: pulumi.Bool(false),
		},
		RequiredCodeScanning: &github.OrganizationRulesetRulesRequiredCodeScanningArgs{
			RequiredCodeScanningTools: github.OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolArray{
				&github.OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolArgs{
					AlertsThreshold:         pulumi.String("string"),
					SecurityAlertsThreshold: pulumi.String("string"),
					Tool:                    pulumi.String("string"),
				},
			},
		},
		RequiredLinearHistory: pulumi.Bool(false),
		RequiredSignatures:    pulumi.Bool(false),
		RequiredStatusChecks: &github.OrganizationRulesetRulesRequiredStatusChecksArgs{
			RequiredChecks: github.OrganizationRulesetRulesRequiredStatusChecksRequiredCheckArray{
				&github.OrganizationRulesetRulesRequiredStatusChecksRequiredCheckArgs{
					Context:       pulumi.String("string"),
					IntegrationId: pulumi.Int(0),
				},
			},
			StrictRequiredStatusChecksPolicy: pulumi.Bool(false),
		},
		RequiredWorkflows: &github.OrganizationRulesetRulesRequiredWorkflowsArgs{
			RequiredWorkflows: github.OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowArray{
				&github.OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowArgs{
					Path:         pulumi.String("string"),
					RepositoryId: pulumi.Int(0),
					Ref:          pulumi.String("string"),
				},
			},
		},
		TagNamePattern: &github.OrganizationRulesetRulesTagNamePatternArgs{
			Operator: pulumi.String("string"),
			Pattern:  pulumi.String("string"),
			Name:     pulumi.String("string"),
			Negate:   pulumi.Bool(false),
		},
		Update: pulumi.Bool(false),
	},
	Target: pulumi.String("string"),
	BypassActors: github.OrganizationRulesetBypassActorArray{
		&github.OrganizationRulesetBypassActorArgs{
			ActorId:    pulumi.Int(0),
			ActorType:  pulumi.String("string"),
			BypassMode: pulumi.String("string"),
		},
	},
	Conditions: &github.OrganizationRulesetConditionsArgs{
		RefName: &github.OrganizationRulesetConditionsRefNameArgs{
			Excludes: pulumi.StringArray{
				pulumi.String("string"),
			},
			Includes: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		RepositoryIds: pulumi.IntArray{
			pulumi.Int(0),
		},
		RepositoryName: &github.OrganizationRulesetConditionsRepositoryNameArgs{
			Excludes: pulumi.StringArray{
				pulumi.String("string"),
			},
			Includes: pulumi.StringArray{
				pulumi.String("string"),
			},
			Protected: pulumi.Bool(false),
		},
	},
	Name: pulumi.String("string"),
})

    var organizationRulesetResource = new OrganizationRuleset("organizationRulesetResource", OrganizationRulesetArgs.builder()
    .enforcement("string")
    .rules(OrganizationRulesetRulesArgs.builder()
        .branchNamePattern(OrganizationRulesetRulesBranchNamePatternArgs.builder()
            .operator("string")
            .pattern("string")
            .name("string")
            .negate(false)
            .build())
        .commitAuthorEmailPattern(OrganizationRulesetRulesCommitAuthorEmailPatternArgs.builder()
            .operator("string")
            .pattern("string")
            .name("string")
            .negate(false)
            .build())
        .commitMessagePattern(OrganizationRulesetRulesCommitMessagePatternArgs.builder()
            .operator("string")
            .pattern("string")
            .name("string")
            .negate(false)
            .build())
        .committerEmailPattern(OrganizationRulesetRulesCommitterEmailPatternArgs.builder()
            .operator("string")
            .pattern("string")
            .name("string")
            .negate(false)
            .build())
        .creation(false)
        .deletion(false)
        .nonFastForward(false)
        .pullRequest(OrganizationRulesetRulesPullRequestArgs.builder()
            .dismissStaleReviewsOnPush(false)
            .requireCodeOwnerReview(false)
            .requireLastPushApproval(false)
            .requiredApprovingReviewCount(0)
            .requiredReviewThreadResolution(false)
            .build())
        .requiredCodeScanning(OrganizationRulesetRulesRequiredCodeScanningArgs.builder()
            .requiredCodeScanningTools(OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolArgs.builder()
                .alertsThreshold("string")
                .securityAlertsThreshold("string")
                .tool("string")
                .build())
            .build())
        .requiredLinearHistory(false)
        .requiredSignatures(false)
        .requiredStatusChecks(OrganizationRulesetRulesRequiredStatusChecksArgs.builder()
            .requiredChecks(OrganizationRulesetRulesRequiredStatusChecksRequiredCheckArgs.builder()
                .context("string")
                .integrationId(0)
                .build())
            .strictRequiredStatusChecksPolicy(false)
            .build())
        .requiredWorkflows(OrganizationRulesetRulesRequiredWorkflowsArgs.builder()
            .requiredWorkflows(OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowArgs.builder()
                .path("string")
                .repositoryId(0)
                .ref("string")
                .build())
            .build())
        .tagNamePattern(OrganizationRulesetRulesTagNamePatternArgs.builder()
            .operator("string")
            .pattern("string")
            .name("string")
            .negate(false)
            .build())
        .update(false)
        .build())
    .target("string")
    .bypassActors(OrganizationRulesetBypassActorArgs.builder()
        .actorId(0)
        .actorType("string")
        .bypassMode("string")
        .build())
    .conditions(OrganizationRulesetConditionsArgs.builder()
        .refName(OrganizationRulesetConditionsRefNameArgs.builder()
            .excludes("string")
            .includes("string")
            .build())
        .repositoryIds(0)
        .repositoryName(OrganizationRulesetConditionsRepositoryNameArgs.builder()
            .excludes("string")
            .includes("string")
            .protected_(false)
            .build())
        .build())
    .name("string")
    .build());

    organization_ruleset_resource = github.OrganizationRuleset("organizationRulesetResource",
    enforcement="string",
    rules={
        "branch_name_pattern": {
            "operator": "string",
            "pattern": "string",
            "name": "string",
            "negate": False,
        },
        "commit_author_email_pattern": {
            "operator": "string",
            "pattern": "string",
            "name": "string",
            "negate": False,
        },
        "commit_message_pattern": {
            "operator": "string",
            "pattern": "string",
            "name": "string",
            "negate": False,
        },
        "committer_email_pattern": {
            "operator": "string",
            "pattern": "string",
            "name": "string",
            "negate": False,
        },
        "creation": False,
        "deletion": False,
        "non_fast_forward": False,
        "pull_request": {
            "dismiss_stale_reviews_on_push": False,
            "require_code_owner_review": False,
            "require_last_push_approval": False,
            "required_approving_review_count": 0,
            "required_review_thread_resolution": False,
        },
        "required_code_scanning": {
            "required_code_scanning_tools": [{
                "alerts_threshold": "string",
                "security_alerts_threshold": "string",
                "tool": "string",
            }],
        },
        "required_linear_history": False,
        "required_signatures": False,
        "required_status_checks": {
            "required_checks": [{
                "context": "string",
                "integration_id": 0,
            }],
            "strict_required_status_checks_policy": False,
        },
        "required_workflows": {
            "required_workflows": [{
                "path": "string",
                "repository_id": 0,
                "ref": "string",
            }],
        },
        "tag_name_pattern": {
            "operator": "string",
            "pattern": "string",
            "name": "string",
            "negate": False,
        },
        "update": False,
    },
    target="string",
    bypass_actors=[{
        "actor_id": 0,
        "actor_type": "string",
        "bypass_mode": "string",
    }],
    conditions={
        "ref_name": {
            "excludes": ["string"],
            "includes": ["string"],
        },
        "repository_ids": [0],
        "repository_name": {
            "excludes": ["string"],
            "includes": ["string"],
            "protected": False,
        },
    },
    name="string")

    const organizationRulesetResource = new github.OrganizationRuleset("organizationRulesetResource", {
    enforcement: "string",
    rules: {
        branchNamePattern: {
            operator: "string",
            pattern: "string",
            name: "string",
            negate: false,
        },
        commitAuthorEmailPattern: {
            operator: "string",
            pattern: "string",
            name: "string",
            negate: false,
        },
        commitMessagePattern: {
            operator: "string",
            pattern: "string",
            name: "string",
            negate: false,
        },
        committerEmailPattern: {
            operator: "string",
            pattern: "string",
            name: "string",
            negate: false,
        },
        creation: false,
        deletion: false,
        nonFastForward: false,
        pullRequest: {
            dismissStaleReviewsOnPush: false,
            requireCodeOwnerReview: false,
            requireLastPushApproval: false,
            requiredApprovingReviewCount: 0,
            requiredReviewThreadResolution: false,
        },
        requiredCodeScanning: {
            requiredCodeScanningTools: [{
                alertsThreshold: "string",
                securityAlertsThreshold: "string",
                tool: "string",
            }],
        },
        requiredLinearHistory: false,
        requiredSignatures: false,
        requiredStatusChecks: {
            requiredChecks: [{
                context: "string",
                integrationId: 0,
            }],
            strictRequiredStatusChecksPolicy: false,
        },
        requiredWorkflows: {
            requiredWorkflows: [{
                path: "string",
                repositoryId: 0,
                ref: "string",
            }],
        },
        tagNamePattern: {
            operator: "string",
            pattern: "string",
            name: "string",
            negate: false,
        },
        update: false,
    },
    target: "string",
    bypassActors: [{
        actorId: 0,
        actorType: "string",
        bypassMode: "string",
    }],
    conditions: {
        refName: {
            excludes: ["string"],
            includes: ["string"],
        },
        repositoryIds: [0],
        repositoryName: {
            excludes: ["string"],
            includes: ["string"],
            "protected": false,
        },
    },
    name: "string",
});

    type: github:OrganizationRuleset
properties:
    bypassActors:
        - actorId: 0
          actorType: string
          bypassMode: string
    conditions:
        refName:
            excludes:
                - string
            includes:
                - string
        repositoryIds:
            - 0
        repositoryName:
            excludes:
                - string
            includes:
                - string
            protected: false
    enforcement: string
    name: string
    rules:
        branchNamePattern:
            name: string
            negate: false
            operator: string
            pattern: string
        commitAuthorEmailPattern:
            name: string
            negate: false
            operator: string
            pattern: string
        commitMessagePattern:
            name: string
            negate: false
            operator: string
            pattern: string
        committerEmailPattern:
            name: string
            negate: false
            operator: string
            pattern: string
        creation: false
        deletion: false
        nonFastForward: false
        pullRequest:
            dismissStaleReviewsOnPush: false
            requireCodeOwnerReview: false
            requireLastPushApproval: false
            requiredApprovingReviewCount: 0
            requiredReviewThreadResolution: false
        requiredCodeScanning:
            requiredCodeScanningTools:
                - alertsThreshold: string
                  securityAlertsThreshold: string
                  tool: string
        requiredLinearHistory: false
        requiredSignatures: false
        requiredStatusChecks:
            requiredChecks:
                - context: string
                  integrationId: 0
            strictRequiredStatusChecksPolicy: false
        requiredWorkflows:
            requiredWorkflows:
                - path: string
                  ref: string
                  repositoryId: 0
        tagNamePattern:
            name: string
            negate: false
            operator: string
            pattern: string
        update: false
    target: string

    OrganizationRuleset Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OrganizationRuleset resource accepts the following input properties:

    Enforcement string
    (String) Possible values for Enforcement are disabled, active, evaluate. Note: evaluate is currently only supported for owners of type organization.
    Rules OrganizationRulesetRules
    (Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)
    Target string
    (String) Possible values are branch and tag.
    BypassActors List<OrganizationRulesetBypassActor>
    (Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)
    Conditions OrganizationRulesetConditions
    (Block List, Max: 1) Parameters for an organization ruleset condition. ref_name is required alongside one of repository_name or repository_id. (see below for nested schema)
    Name string
    (String) The name of the ruleset.
    Enforcement string
    (String) Possible values for Enforcement are disabled, active, evaluate. Note: evaluate is currently only supported for owners of type organization.
    Rules OrganizationRulesetRulesArgs
    (Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)
    Target string
    (String) Possible values are branch and tag.
    BypassActors []OrganizationRulesetBypassActorArgs
    (Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)
    Conditions OrganizationRulesetConditionsArgs
    (Block List, Max: 1) Parameters for an organization ruleset condition. ref_name is required alongside one of repository_name or repository_id. (see below for nested schema)
    Name string
    (String) The name of the ruleset.
    enforcement String
    (String) Possible values for Enforcement are disabled, active, evaluate. Note: evaluate is currently only supported for owners of type organization.
    rules OrganizationRulesetRules
    (Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)
    target String
    (String) Possible values are branch and tag.
    bypassActors List<OrganizationRulesetBypassActor>
    (Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)
    conditions OrganizationRulesetConditions
    (Block List, Max: 1) Parameters for an organization ruleset condition. ref_name is required alongside one of repository_name or repository_id. (see below for nested schema)
    name String
    (String) The name of the ruleset.
    enforcement string
    (String) Possible values for Enforcement are disabled, active, evaluate. Note: evaluate is currently only supported for owners of type organization.
    rules OrganizationRulesetRules
    (Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)
    target string
    (String) Possible values are branch and tag.
    bypassActors OrganizationRulesetBypassActor[]
    (Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)
    conditions OrganizationRulesetConditions
    (Block List, Max: 1) Parameters for an organization ruleset condition. ref_name is required alongside one of repository_name or repository_id. (see below for nested schema)
    name string
    (String) The name of the ruleset.
    enforcement str
    (String) Possible values for Enforcement are disabled, active, evaluate. Note: evaluate is currently only supported for owners of type organization.
    rules OrganizationRulesetRulesArgs
    (Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)
    target str
    (String) Possible values are branch and tag.
    bypass_actors Sequence[OrganizationRulesetBypassActorArgs]
    (Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)
    conditions OrganizationRulesetConditionsArgs
    (Block List, Max: 1) Parameters for an organization ruleset condition. ref_name is required alongside one of repository_name or repository_id. (see below for nested schema)
    name str
    (String) The name of the ruleset.
    enforcement String
    (String) Possible values for Enforcement are disabled, active, evaluate. Note: evaluate is currently only supported for owners of type organization.
    rules Property Map
    (Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)
    target String
    (String) Possible values are branch and tag.
    bypassActors List<Property Map>
    (Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)
    conditions Property Map
    (Block List, Max: 1) Parameters for an organization ruleset condition. ref_name is required alongside one of repository_name or repository_id. (see below for nested schema)
    name String
    (String) The name of the ruleset.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OrganizationRuleset resource produces the following output properties:

    Etag string
    (String)
    Id string
    The provider-assigned unique ID for this managed resource.
    NodeId string
    (String) GraphQL global node id for use with v4 API.
    RulesetId int
    (Number) GitHub ID for the ruleset.
    Etag string
    (String)
    Id string
    The provider-assigned unique ID for this managed resource.
    NodeId string
    (String) GraphQL global node id for use with v4 API.
    RulesetId int
    (Number) GitHub ID for the ruleset.
    etag String
    (String)
    id String
    The provider-assigned unique ID for this managed resource.
    nodeId String
    (String) GraphQL global node id for use with v4 API.
    rulesetId Integer
    (Number) GitHub ID for the ruleset.
    etag string
    (String)
    id string
    The provider-assigned unique ID for this managed resource.
    nodeId string
    (String) GraphQL global node id for use with v4 API.
    rulesetId number
    (Number) GitHub ID for the ruleset.
    etag str
    (String)
    id str
    The provider-assigned unique ID for this managed resource.
    node_id str
    (String) GraphQL global node id for use with v4 API.
    ruleset_id int
    (Number) GitHub ID for the ruleset.
    etag String
    (String)
    id String
    The provider-assigned unique ID for this managed resource.
    nodeId String
    (String) GraphQL global node id for use with v4 API.
    rulesetId Number
    (Number) GitHub ID for the ruleset.

    Look up Existing OrganizationRuleset Resource

    Get an existing OrganizationRuleset resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OrganizationRulesetState, opts?: CustomResourceOptions): OrganizationRuleset
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bypass_actors: Optional[Sequence[OrganizationRulesetBypassActorArgs]] = None,
        conditions: Optional[OrganizationRulesetConditionsArgs] = None,
        enforcement: Optional[str] = None,
        etag: Optional[str] = None,
        name: Optional[str] = None,
        node_id: Optional[str] = None,
        rules: Optional[OrganizationRulesetRulesArgs] = None,
        ruleset_id: Optional[int] = None,
        target: Optional[str] = None) -> OrganizationRuleset
    func GetOrganizationRuleset(ctx *Context, name string, id IDInput, state *OrganizationRulesetState, opts ...ResourceOption) (*OrganizationRuleset, error)
    public static OrganizationRuleset Get(string name, Input<string> id, OrganizationRulesetState? state, CustomResourceOptions? opts = null)
    public static OrganizationRuleset get(String name, Output<String> id, OrganizationRulesetState state, CustomResourceOptions options)
    resources:  _:    type: github:OrganizationRuleset    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BypassActors List<OrganizationRulesetBypassActor>
    (Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)
    Conditions OrganizationRulesetConditions
    (Block List, Max: 1) Parameters for an organization ruleset condition. ref_name is required alongside one of repository_name or repository_id. (see below for nested schema)
    Enforcement string
    (String) Possible values for Enforcement are disabled, active, evaluate. Note: evaluate is currently only supported for owners of type organization.
    Etag string
    (String)
    Name string
    (String) The name of the ruleset.
    NodeId string
    (String) GraphQL global node id for use with v4 API.
    Rules OrganizationRulesetRules
    (Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)
    RulesetId int
    (Number) GitHub ID for the ruleset.
    Target string
    (String) Possible values are branch and tag.
    BypassActors []OrganizationRulesetBypassActorArgs
    (Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)
    Conditions OrganizationRulesetConditionsArgs
    (Block List, Max: 1) Parameters for an organization ruleset condition. ref_name is required alongside one of repository_name or repository_id. (see below for nested schema)
    Enforcement string
    (String) Possible values for Enforcement are disabled, active, evaluate. Note: evaluate is currently only supported for owners of type organization.
    Etag string
    (String)
    Name string
    (String) The name of the ruleset.
    NodeId string
    (String) GraphQL global node id for use with v4 API.
    Rules OrganizationRulesetRulesArgs
    (Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)
    RulesetId int
    (Number) GitHub ID for the ruleset.
    Target string
    (String) Possible values are branch and tag.
    bypassActors List<OrganizationRulesetBypassActor>
    (Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)
    conditions OrganizationRulesetConditions
    (Block List, Max: 1) Parameters for an organization ruleset condition. ref_name is required alongside one of repository_name or repository_id. (see below for nested schema)
    enforcement String
    (String) Possible values for Enforcement are disabled, active, evaluate. Note: evaluate is currently only supported for owners of type organization.
    etag String
    (String)
    name String
    (String) The name of the ruleset.
    nodeId String
    (String) GraphQL global node id for use with v4 API.
    rules OrganizationRulesetRules
    (Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)
    rulesetId Integer
    (Number) GitHub ID for the ruleset.
    target String
    (String) Possible values are branch and tag.
    bypassActors OrganizationRulesetBypassActor[]
    (Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)
    conditions OrganizationRulesetConditions
    (Block List, Max: 1) Parameters for an organization ruleset condition. ref_name is required alongside one of repository_name or repository_id. (see below for nested schema)
    enforcement string
    (String) Possible values for Enforcement are disabled, active, evaluate. Note: evaluate is currently only supported for owners of type organization.
    etag string
    (String)
    name string
    (String) The name of the ruleset.
    nodeId string
    (String) GraphQL global node id for use with v4 API.
    rules OrganizationRulesetRules
    (Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)
    rulesetId number
    (Number) GitHub ID for the ruleset.
    target string
    (String) Possible values are branch and tag.
    bypass_actors Sequence[OrganizationRulesetBypassActorArgs]
    (Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)
    conditions OrganizationRulesetConditionsArgs
    (Block List, Max: 1) Parameters for an organization ruleset condition. ref_name is required alongside one of repository_name or repository_id. (see below for nested schema)
    enforcement str
    (String) Possible values for Enforcement are disabled, active, evaluate. Note: evaluate is currently only supported for owners of type organization.
    etag str
    (String)
    name str
    (String) The name of the ruleset.
    node_id str
    (String) GraphQL global node id for use with v4 API.
    rules OrganizationRulesetRulesArgs
    (Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)
    ruleset_id int
    (Number) GitHub ID for the ruleset.
    target str
    (String) Possible values are branch and tag.
    bypassActors List<Property Map>
    (Block List) The actors that can bypass the rules in this ruleset. (see below for nested schema)
    conditions Property Map
    (Block List, Max: 1) Parameters for an organization ruleset condition. ref_name is required alongside one of repository_name or repository_id. (see below for nested schema)
    enforcement String
    (String) Possible values for Enforcement are disabled, active, evaluate. Note: evaluate is currently only supported for owners of type organization.
    etag String
    (String)
    name String
    (String) The name of the ruleset.
    nodeId String
    (String) GraphQL global node id for use with v4 API.
    rules Property Map
    (Block List, Min: 1, Max: 1) Rules within the ruleset. (see below for nested schema)
    rulesetId Number
    (Number) GitHub ID for the ruleset.
    target String
    (String) Possible values are branch and tag.

    Supporting Types

    OrganizationRulesetBypassActor, OrganizationRulesetBypassActorArgs

    ActorId int
    (Number) The ID of the actor that can bypass a ruleset.
    ActorType string
    The type of actor that can bypass a ruleset. Can be one of: RepositoryRole, Team, Integration, OrganizationAdmin.
    BypassMode string

    (String) When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. Can be one of: always, pull_request.

    ~>Note: at the time of writing this, the following actor types correspond to the following actor IDs:

    • OrganizationAdmin > 1
    • RepositoryRole (This is the actor type, the following are the base repository roles and their associated IDs.)
    ActorId int
    (Number) The ID of the actor that can bypass a ruleset.
    ActorType string
    The type of actor that can bypass a ruleset. Can be one of: RepositoryRole, Team, Integration, OrganizationAdmin.
    BypassMode string

    (String) When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. Can be one of: always, pull_request.

    ~>Note: at the time of writing this, the following actor types correspond to the following actor IDs:

    • OrganizationAdmin > 1
    • RepositoryRole (This is the actor type, the following are the base repository roles and their associated IDs.)
    actorId Integer
    (Number) The ID of the actor that can bypass a ruleset.
    actorType String
    The type of actor that can bypass a ruleset. Can be one of: RepositoryRole, Team, Integration, OrganizationAdmin.
    bypassMode String

    (String) When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. Can be one of: always, pull_request.

    ~>Note: at the time of writing this, the following actor types correspond to the following actor IDs:

    • OrganizationAdmin > 1
    • RepositoryRole (This is the actor type, the following are the base repository roles and their associated IDs.)
    actorId number
    (Number) The ID of the actor that can bypass a ruleset.
    actorType string
    The type of actor that can bypass a ruleset. Can be one of: RepositoryRole, Team, Integration, OrganizationAdmin.
    bypassMode string

    (String) When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. Can be one of: always, pull_request.

    ~>Note: at the time of writing this, the following actor types correspond to the following actor IDs:

    • OrganizationAdmin > 1
    • RepositoryRole (This is the actor type, the following are the base repository roles and their associated IDs.)
    actor_id int
    (Number) The ID of the actor that can bypass a ruleset.
    actor_type str
    The type of actor that can bypass a ruleset. Can be one of: RepositoryRole, Team, Integration, OrganizationAdmin.
    bypass_mode str

    (String) When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. Can be one of: always, pull_request.

    ~>Note: at the time of writing this, the following actor types correspond to the following actor IDs:

    • OrganizationAdmin > 1
    • RepositoryRole (This is the actor type, the following are the base repository roles and their associated IDs.)
    actorId Number
    (Number) The ID of the actor that can bypass a ruleset.
    actorType String
    The type of actor that can bypass a ruleset. Can be one of: RepositoryRole, Team, Integration, OrganizationAdmin.
    bypassMode String

    (String) When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. Can be one of: always, pull_request.

    ~>Note: at the time of writing this, the following actor types correspond to the following actor IDs:

    • OrganizationAdmin > 1
    • RepositoryRole (This is the actor type, the following are the base repository roles and their associated IDs.)

    OrganizationRulesetConditions, OrganizationRulesetConditionsArgs

    RefName OrganizationRulesetConditionsRefName
    (Block List, Min: 1, Max: 1) (see below for nested schema)
    RepositoryIds List<int>
    The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. Conflicts with repository_name.
    RepositoryName OrganizationRulesetConditionsRepositoryName

    Conflicts with repository_id. (see below for nested schema)

    One of repository_id and repository_name must be set for the rule to target any repositories.

    RefName OrganizationRulesetConditionsRefName
    (Block List, Min: 1, Max: 1) (see below for nested schema)
    RepositoryIds []int
    The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. Conflicts with repository_name.
    RepositoryName OrganizationRulesetConditionsRepositoryName

    Conflicts with repository_id. (see below for nested schema)

    One of repository_id and repository_name must be set for the rule to target any repositories.

    refName OrganizationRulesetConditionsRefName
    (Block List, Min: 1, Max: 1) (see below for nested schema)
    repositoryIds List<Integer>
    The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. Conflicts with repository_name.
    repositoryName OrganizationRulesetConditionsRepositoryName

    Conflicts with repository_id. (see below for nested schema)

    One of repository_id and repository_name must be set for the rule to target any repositories.

    refName OrganizationRulesetConditionsRefName
    (Block List, Min: 1, Max: 1) (see below for nested schema)
    repositoryIds number[]
    The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. Conflicts with repository_name.
    repositoryName OrganizationRulesetConditionsRepositoryName

    Conflicts with repository_id. (see below for nested schema)

    One of repository_id and repository_name must be set for the rule to target any repositories.

    ref_name OrganizationRulesetConditionsRefName
    (Block List, Min: 1, Max: 1) (see below for nested schema)
    repository_ids Sequence[int]
    The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. Conflicts with repository_name.
    repository_name OrganizationRulesetConditionsRepositoryName

    Conflicts with repository_id. (see below for nested schema)

    One of repository_id and repository_name must be set for the rule to target any repositories.

    refName Property Map
    (Block List, Min: 1, Max: 1) (see below for nested schema)
    repositoryIds List<Number>
    The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. Conflicts with repository_name.
    repositoryName Property Map

    Conflicts with repository_id. (see below for nested schema)

    One of repository_id and repository_name must be set for the rule to target any repositories.

    OrganizationRulesetConditionsRefName, OrganizationRulesetConditionsRefNameArgs

    Excludes List<string>
    Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.
    Includes List<string>
    Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.
    Excludes []string
    Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.
    Includes []string
    Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.
    excludes List<String>
    Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.
    includes List<String>
    Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.
    excludes string[]
    Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.
    includes string[]
    Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.
    excludes Sequence[str]
    Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.
    includes Sequence[str]
    Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.
    excludes List<String>
    Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.
    includes List<String>
    Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

    OrganizationRulesetConditionsRepositoryName, OrganizationRulesetConditionsRepositoryNameArgs

    Excludes List<string>
    Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
    Includes List<string>
    Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.
    Protected bool
    Whether renaming of target repositories is prevented.
    Excludes []string
    Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
    Includes []string
    Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.
    Protected bool
    Whether renaming of target repositories is prevented.
    excludes List<String>
    Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
    includes List<String>
    Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.
    protected_ Boolean
    Whether renaming of target repositories is prevented.
    excludes string[]
    Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
    includes string[]
    Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.
    protected boolean
    Whether renaming of target repositories is prevented.
    excludes Sequence[str]
    Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
    includes Sequence[str]
    Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.
    protected bool
    Whether renaming of target repositories is prevented.
    excludes List<String>
    Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
    includes List<String>
    Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~ALL to include all repositories.
    protected Boolean
    Whether renaming of target repositories is prevented.

    OrganizationRulesetRules, OrganizationRulesetRulesArgs

    BranchNamePattern OrganizationRulesetRulesBranchNamePattern
    (Block List, Max: 1) Parameters to be used for the branch_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with tag_name_pattern as it only applies to rulesets with target branch. (see below for nested schema)
    CommitAuthorEmailPattern OrganizationRulesetRulesCommitAuthorEmailPattern
    (Block List, Max: 1) Parameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    CommitMessagePattern OrganizationRulesetRulesCommitMessagePattern
    (Block List, Max: 1) Parameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    CommitterEmailPattern OrganizationRulesetRulesCommitterEmailPattern
    (Block List, Max: 1) Parameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    Creation bool
    (Boolean) Only allow users with bypass permission to create matching refs.
    Deletion bool
    (Boolean) Only allow users with bypass permissions to delete matching refs.
    NonFastForward bool
    (Boolean) Prevent users with push access from force pushing to branches.
    PullRequest OrganizationRulesetRulesPullRequest
    (Block List, Max: 1) Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. (see below for nested schema)
    RequiredCodeScanning OrganizationRulesetRulesRequiredCodeScanning
    (Block List, Max: 1) Define which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. Multiple code scanning tools can be specified. (see below for nested schema)
    RequiredLinearHistory bool
    (Boolean) Prevent merge commits from being pushed to matching branches.
    RequiredSignatures bool
    (Boolean) Commits pushed to matching branches must have verified signatures.
    RequiredStatusChecks OrganizationRulesetRulesRequiredStatusChecks
    (Block List, Max: 1) Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed. (see below for nested schema)
    RequiredWorkflows OrganizationRulesetRulesRequiredWorkflows
    (Block List, Max: 1) Define which Actions workflows must pass before changes can be merged into a branch matching the rule. Multiple workflows can be specified. (see below for nested schema)
    TagNamePattern OrganizationRulesetRulesTagNamePattern
    (Block List, Max: 1) Parameters to be used for the tag_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with branch_name_pattern as it only applies to rulesets with target tag. (see below for nested schema)
    Update bool
    (Boolean) Only allow users with bypass permission to update matching refs.
    BranchNamePattern OrganizationRulesetRulesBranchNamePattern
    (Block List, Max: 1) Parameters to be used for the branch_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with tag_name_pattern as it only applies to rulesets with target branch. (see below for nested schema)
    CommitAuthorEmailPattern OrganizationRulesetRulesCommitAuthorEmailPattern
    (Block List, Max: 1) Parameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    CommitMessagePattern OrganizationRulesetRulesCommitMessagePattern
    (Block List, Max: 1) Parameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    CommitterEmailPattern OrganizationRulesetRulesCommitterEmailPattern
    (Block List, Max: 1) Parameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    Creation bool
    (Boolean) Only allow users with bypass permission to create matching refs.
    Deletion bool
    (Boolean) Only allow users with bypass permissions to delete matching refs.
    NonFastForward bool
    (Boolean) Prevent users with push access from force pushing to branches.
    PullRequest OrganizationRulesetRulesPullRequest
    (Block List, Max: 1) Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. (see below for nested schema)
    RequiredCodeScanning OrganizationRulesetRulesRequiredCodeScanning
    (Block List, Max: 1) Define which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. Multiple code scanning tools can be specified. (see below for nested schema)
    RequiredLinearHistory bool
    (Boolean) Prevent merge commits from being pushed to matching branches.
    RequiredSignatures bool
    (Boolean) Commits pushed to matching branches must have verified signatures.
    RequiredStatusChecks OrganizationRulesetRulesRequiredStatusChecks
    (Block List, Max: 1) Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed. (see below for nested schema)
    RequiredWorkflows OrganizationRulesetRulesRequiredWorkflows
    (Block List, Max: 1) Define which Actions workflows must pass before changes can be merged into a branch matching the rule. Multiple workflows can be specified. (see below for nested schema)
    TagNamePattern OrganizationRulesetRulesTagNamePattern
    (Block List, Max: 1) Parameters to be used for the tag_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with branch_name_pattern as it only applies to rulesets with target tag. (see below for nested schema)
    Update bool
    (Boolean) Only allow users with bypass permission to update matching refs.
    branchNamePattern OrganizationRulesetRulesBranchNamePattern
    (Block List, Max: 1) Parameters to be used for the branch_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with tag_name_pattern as it only applies to rulesets with target branch. (see below for nested schema)
    commitAuthorEmailPattern OrganizationRulesetRulesCommitAuthorEmailPattern
    (Block List, Max: 1) Parameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    commitMessagePattern OrganizationRulesetRulesCommitMessagePattern
    (Block List, Max: 1) Parameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    committerEmailPattern OrganizationRulesetRulesCommitterEmailPattern
    (Block List, Max: 1) Parameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    creation Boolean
    (Boolean) Only allow users with bypass permission to create matching refs.
    deletion Boolean
    (Boolean) Only allow users with bypass permissions to delete matching refs.
    nonFastForward Boolean
    (Boolean) Prevent users with push access from force pushing to branches.
    pullRequest OrganizationRulesetRulesPullRequest
    (Block List, Max: 1) Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. (see below for nested schema)
    requiredCodeScanning OrganizationRulesetRulesRequiredCodeScanning
    (Block List, Max: 1) Define which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. Multiple code scanning tools can be specified. (see below for nested schema)
    requiredLinearHistory Boolean
    (Boolean) Prevent merge commits from being pushed to matching branches.
    requiredSignatures Boolean
    (Boolean) Commits pushed to matching branches must have verified signatures.
    requiredStatusChecks OrganizationRulesetRulesRequiredStatusChecks
    (Block List, Max: 1) Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed. (see below for nested schema)
    requiredWorkflows OrganizationRulesetRulesRequiredWorkflows
    (Block List, Max: 1) Define which Actions workflows must pass before changes can be merged into a branch matching the rule. Multiple workflows can be specified. (see below for nested schema)
    tagNamePattern OrganizationRulesetRulesTagNamePattern
    (Block List, Max: 1) Parameters to be used for the tag_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with branch_name_pattern as it only applies to rulesets with target tag. (see below for nested schema)
    update Boolean
    (Boolean) Only allow users with bypass permission to update matching refs.
    branchNamePattern OrganizationRulesetRulesBranchNamePattern
    (Block List, Max: 1) Parameters to be used for the branch_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with tag_name_pattern as it only applies to rulesets with target branch. (see below for nested schema)
    commitAuthorEmailPattern OrganizationRulesetRulesCommitAuthorEmailPattern
    (Block List, Max: 1) Parameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    commitMessagePattern OrganizationRulesetRulesCommitMessagePattern
    (Block List, Max: 1) Parameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    committerEmailPattern OrganizationRulesetRulesCommitterEmailPattern
    (Block List, Max: 1) Parameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    creation boolean
    (Boolean) Only allow users with bypass permission to create matching refs.
    deletion boolean
    (Boolean) Only allow users with bypass permissions to delete matching refs.
    nonFastForward boolean
    (Boolean) Prevent users with push access from force pushing to branches.
    pullRequest OrganizationRulesetRulesPullRequest
    (Block List, Max: 1) Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. (see below for nested schema)
    requiredCodeScanning OrganizationRulesetRulesRequiredCodeScanning
    (Block List, Max: 1) Define which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. Multiple code scanning tools can be specified. (see below for nested schema)
    requiredLinearHistory boolean
    (Boolean) Prevent merge commits from being pushed to matching branches.
    requiredSignatures boolean
    (Boolean) Commits pushed to matching branches must have verified signatures.
    requiredStatusChecks OrganizationRulesetRulesRequiredStatusChecks
    (Block List, Max: 1) Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed. (see below for nested schema)
    requiredWorkflows OrganizationRulesetRulesRequiredWorkflows
    (Block List, Max: 1) Define which Actions workflows must pass before changes can be merged into a branch matching the rule. Multiple workflows can be specified. (see below for nested schema)
    tagNamePattern OrganizationRulesetRulesTagNamePattern
    (Block List, Max: 1) Parameters to be used for the tag_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with branch_name_pattern as it only applies to rulesets with target tag. (see below for nested schema)
    update boolean
    (Boolean) Only allow users with bypass permission to update matching refs.
    branch_name_pattern OrganizationRulesetRulesBranchNamePattern
    (Block List, Max: 1) Parameters to be used for the branch_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with tag_name_pattern as it only applies to rulesets with target branch. (see below for nested schema)
    commit_author_email_pattern OrganizationRulesetRulesCommitAuthorEmailPattern
    (Block List, Max: 1) Parameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    commit_message_pattern OrganizationRulesetRulesCommitMessagePattern
    (Block List, Max: 1) Parameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    committer_email_pattern OrganizationRulesetRulesCommitterEmailPattern
    (Block List, Max: 1) Parameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    creation bool
    (Boolean) Only allow users with bypass permission to create matching refs.
    deletion bool
    (Boolean) Only allow users with bypass permissions to delete matching refs.
    non_fast_forward bool
    (Boolean) Prevent users with push access from force pushing to branches.
    pull_request OrganizationRulesetRulesPullRequest
    (Block List, Max: 1) Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. (see below for nested schema)
    required_code_scanning OrganizationRulesetRulesRequiredCodeScanning
    (Block List, Max: 1) Define which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. Multiple code scanning tools can be specified. (see below for nested schema)
    required_linear_history bool
    (Boolean) Prevent merge commits from being pushed to matching branches.
    required_signatures bool
    (Boolean) Commits pushed to matching branches must have verified signatures.
    required_status_checks OrganizationRulesetRulesRequiredStatusChecks
    (Block List, Max: 1) Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed. (see below for nested schema)
    required_workflows OrganizationRulesetRulesRequiredWorkflows
    (Block List, Max: 1) Define which Actions workflows must pass before changes can be merged into a branch matching the rule. Multiple workflows can be specified. (see below for nested schema)
    tag_name_pattern OrganizationRulesetRulesTagNamePattern
    (Block List, Max: 1) Parameters to be used for the tag_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with branch_name_pattern as it only applies to rulesets with target tag. (see below for nested schema)
    update bool
    (Boolean) Only allow users with bypass permission to update matching refs.
    branchNamePattern Property Map
    (Block List, Max: 1) Parameters to be used for the branch_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with tag_name_pattern as it only applies to rulesets with target branch. (see below for nested schema)
    commitAuthorEmailPattern Property Map
    (Block List, Max: 1) Parameters to be used for the commit_author_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    commitMessagePattern Property Map
    (Block List, Max: 1) Parameters to be used for the commit_message_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    committerEmailPattern Property Map
    (Block List, Max: 1) Parameters to be used for the committer_email_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. (see below for nested schema)
    creation Boolean
    (Boolean) Only allow users with bypass permission to create matching refs.
    deletion Boolean
    (Boolean) Only allow users with bypass permissions to delete matching refs.
    nonFastForward Boolean
    (Boolean) Prevent users with push access from force pushing to branches.
    pullRequest Property Map
    (Block List, Max: 1) Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. (see below for nested schema)
    requiredCodeScanning Property Map
    (Block List, Max: 1) Define which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. Multiple code scanning tools can be specified. (see below for nested schema)
    requiredLinearHistory Boolean
    (Boolean) Prevent merge commits from being pushed to matching branches.
    requiredSignatures Boolean
    (Boolean) Commits pushed to matching branches must have verified signatures.
    requiredStatusChecks Property Map
    (Block List, Max: 1) Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed. (see below for nested schema)
    requiredWorkflows Property Map
    (Block List, Max: 1) Define which Actions workflows must pass before changes can be merged into a branch matching the rule. Multiple workflows can be specified. (see below for nested schema)
    tagNamePattern Property Map
    (Block List, Max: 1) Parameters to be used for the tag_name_pattern rule. This rule only applies to repositories within an enterprise, it cannot be applied to repositories owned by individuals or regular organizations. Conflicts with branch_name_pattern as it only applies to rulesets with target tag. (see below for nested schema)
    update Boolean
    (Boolean) Only allow users with bypass permission to update matching refs.

    OrganizationRulesetRulesBranchNamePattern, OrganizationRulesetRulesBranchNamePatternArgs

    Operator string
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    Pattern string
    The pattern to match with.
    Name string
    (String) The name of the ruleset.
    Negate bool
    If true, the rule will fail if the pattern matches.
    Operator string
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    Pattern string
    The pattern to match with.
    Name string
    (String) The name of the ruleset.
    Negate bool
    If true, the rule will fail if the pattern matches.
    operator String
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern String
    The pattern to match with.
    name String
    (String) The name of the ruleset.
    negate Boolean
    If true, the rule will fail if the pattern matches.
    operator string
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern string
    The pattern to match with.
    name string
    (String) The name of the ruleset.
    negate boolean
    If true, the rule will fail if the pattern matches.
    operator str
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern str
    The pattern to match with.
    name str
    (String) The name of the ruleset.
    negate bool
    If true, the rule will fail if the pattern matches.
    operator String
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern String
    The pattern to match with.
    name String
    (String) The name of the ruleset.
    negate Boolean
    If true, the rule will fail if the pattern matches.

    OrganizationRulesetRulesCommitAuthorEmailPattern, OrganizationRulesetRulesCommitAuthorEmailPatternArgs

    Operator string
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    Pattern string
    The pattern to match with.
    Name string
    (String) The name of the ruleset.
    Negate bool
    If true, the rule will fail if the pattern matches.
    Operator string
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    Pattern string
    The pattern to match with.
    Name string
    (String) The name of the ruleset.
    Negate bool
    If true, the rule will fail if the pattern matches.
    operator String
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern String
    The pattern to match with.
    name String
    (String) The name of the ruleset.
    negate Boolean
    If true, the rule will fail if the pattern matches.
    operator string
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern string
    The pattern to match with.
    name string
    (String) The name of the ruleset.
    negate boolean
    If true, the rule will fail if the pattern matches.
    operator str
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern str
    The pattern to match with.
    name str
    (String) The name of the ruleset.
    negate bool
    If true, the rule will fail if the pattern matches.
    operator String
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern String
    The pattern to match with.
    name String
    (String) The name of the ruleset.
    negate Boolean
    If true, the rule will fail if the pattern matches.

    OrganizationRulesetRulesCommitMessagePattern, OrganizationRulesetRulesCommitMessagePatternArgs

    Operator string
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    Pattern string
    The pattern to match with.
    Name string
    (String) The name of the ruleset.
    Negate bool
    If true, the rule will fail if the pattern matches.
    Operator string
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    Pattern string
    The pattern to match with.
    Name string
    (String) The name of the ruleset.
    Negate bool
    If true, the rule will fail if the pattern matches.
    operator String
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern String
    The pattern to match with.
    name String
    (String) The name of the ruleset.
    negate Boolean
    If true, the rule will fail if the pattern matches.
    operator string
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern string
    The pattern to match with.
    name string
    (String) The name of the ruleset.
    negate boolean
    If true, the rule will fail if the pattern matches.
    operator str
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern str
    The pattern to match with.
    name str
    (String) The name of the ruleset.
    negate bool
    If true, the rule will fail if the pattern matches.
    operator String
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern String
    The pattern to match with.
    name String
    (String) The name of the ruleset.
    negate Boolean
    If true, the rule will fail if the pattern matches.

    OrganizationRulesetRulesCommitterEmailPattern, OrganizationRulesetRulesCommitterEmailPatternArgs

    Operator string
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    Pattern string
    The pattern to match with.
    Name string
    (String) The name of the ruleset.
    Negate bool
    If true, the rule will fail if the pattern matches.
    Operator string
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    Pattern string
    The pattern to match with.
    Name string
    (String) The name of the ruleset.
    Negate bool
    If true, the rule will fail if the pattern matches.
    operator String
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern String
    The pattern to match with.
    name String
    (String) The name of the ruleset.
    negate Boolean
    If true, the rule will fail if the pattern matches.
    operator string
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern string
    The pattern to match with.
    name string
    (String) The name of the ruleset.
    negate boolean
    If true, the rule will fail if the pattern matches.
    operator str
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern str
    The pattern to match with.
    name str
    (String) The name of the ruleset.
    negate bool
    If true, the rule will fail if the pattern matches.
    operator String
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern String
    The pattern to match with.
    name String
    (String) The name of the ruleset.
    negate Boolean
    If true, the rule will fail if the pattern matches.

    OrganizationRulesetRulesPullRequest, OrganizationRulesetRulesPullRequestArgs

    DismissStaleReviewsOnPush bool
    New, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to false.
    RequireCodeOwnerReview bool
    Require an approving review in pull requests that modify files that have a designated code owner. Defaults to false.
    RequireLastPushApproval bool
    Whether the most recent reviewable push must be approved by someone other than the person who pushed it. Defaults to false.
    RequiredApprovingReviewCount int
    The number of approving reviews that are required before a pull request can be merged. Defaults to 0.
    RequiredReviewThreadResolution bool
    All conversations on code must be resolved before a pull request can be merged. Defaults to false.
    DismissStaleReviewsOnPush bool
    New, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to false.
    RequireCodeOwnerReview bool
    Require an approving review in pull requests that modify files that have a designated code owner. Defaults to false.
    RequireLastPushApproval bool
    Whether the most recent reviewable push must be approved by someone other than the person who pushed it. Defaults to false.
    RequiredApprovingReviewCount int
    The number of approving reviews that are required before a pull request can be merged. Defaults to 0.
    RequiredReviewThreadResolution bool
    All conversations on code must be resolved before a pull request can be merged. Defaults to false.
    dismissStaleReviewsOnPush Boolean
    New, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to false.
    requireCodeOwnerReview Boolean
    Require an approving review in pull requests that modify files that have a designated code owner. Defaults to false.
    requireLastPushApproval Boolean
    Whether the most recent reviewable push must be approved by someone other than the person who pushed it. Defaults to false.
    requiredApprovingReviewCount Integer
    The number of approving reviews that are required before a pull request can be merged. Defaults to 0.
    requiredReviewThreadResolution Boolean
    All conversations on code must be resolved before a pull request can be merged. Defaults to false.
    dismissStaleReviewsOnPush boolean
    New, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to false.
    requireCodeOwnerReview boolean
    Require an approving review in pull requests that modify files that have a designated code owner. Defaults to false.
    requireLastPushApproval boolean
    Whether the most recent reviewable push must be approved by someone other than the person who pushed it. Defaults to false.
    requiredApprovingReviewCount number
    The number of approving reviews that are required before a pull request can be merged. Defaults to 0.
    requiredReviewThreadResolution boolean
    All conversations on code must be resolved before a pull request can be merged. Defaults to false.
    dismiss_stale_reviews_on_push bool
    New, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to false.
    require_code_owner_review bool
    Require an approving review in pull requests that modify files that have a designated code owner. Defaults to false.
    require_last_push_approval bool
    Whether the most recent reviewable push must be approved by someone other than the person who pushed it. Defaults to false.
    required_approving_review_count int
    The number of approving reviews that are required before a pull request can be merged. Defaults to 0.
    required_review_thread_resolution bool
    All conversations on code must be resolved before a pull request can be merged. Defaults to false.
    dismissStaleReviewsOnPush Boolean
    New, reviewable commits pushed will dismiss previous pull request review approvals. Defaults to false.
    requireCodeOwnerReview Boolean
    Require an approving review in pull requests that modify files that have a designated code owner. Defaults to false.
    requireLastPushApproval Boolean
    Whether the most recent reviewable push must be approved by someone other than the person who pushed it. Defaults to false.
    requiredApprovingReviewCount Number
    The number of approving reviews that are required before a pull request can be merged. Defaults to 0.
    requiredReviewThreadResolution Boolean
    All conversations on code must be resolved before a pull request can be merged. Defaults to false.

    OrganizationRulesetRulesRequiredCodeScanning, OrganizationRulesetRulesRequiredCodeScanningArgs

    RequiredCodeScanningTools List<OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool>
    Tools that must provide code scanning results for this rule to pass.
    RequiredCodeScanningTools []OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool
    Tools that must provide code scanning results for this rule to pass.
    requiredCodeScanningTools List<OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool>
    Tools that must provide code scanning results for this rule to pass.
    requiredCodeScanningTools OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool[]
    Tools that must provide code scanning results for this rule to pass.
    requiredCodeScanningTools List<Property Map>
    Tools that must provide code scanning results for this rule to pass.

    OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningTool, OrganizationRulesetRulesRequiredCodeScanningRequiredCodeScanningToolArgs

    AlertsThreshold string
    The severity level at which code scanning results that raise alerts block a reference update. Can be one of: none, errors, errors_and_warnings, all.
    SecurityAlertsThreshold string
    The severity level at which code scanning results that raise security alerts block a reference update. Can be one of: none, critical, high_or_higher, medium_or_higher, all.
    Tool string
    The name of a code scanning tool.
    AlertsThreshold string
    The severity level at which code scanning results that raise alerts block a reference update. Can be one of: none, errors, errors_and_warnings, all.
    SecurityAlertsThreshold string
    The severity level at which code scanning results that raise security alerts block a reference update. Can be one of: none, critical, high_or_higher, medium_or_higher, all.
    Tool string
    The name of a code scanning tool.
    alertsThreshold String
    The severity level at which code scanning results that raise alerts block a reference update. Can be one of: none, errors, errors_and_warnings, all.
    securityAlertsThreshold String
    The severity level at which code scanning results that raise security alerts block a reference update. Can be one of: none, critical, high_or_higher, medium_or_higher, all.
    tool String
    The name of a code scanning tool.
    alertsThreshold string
    The severity level at which code scanning results that raise alerts block a reference update. Can be one of: none, errors, errors_and_warnings, all.
    securityAlertsThreshold string
    The severity level at which code scanning results that raise security alerts block a reference update. Can be one of: none, critical, high_or_higher, medium_or_higher, all.
    tool string
    The name of a code scanning tool.
    alerts_threshold str
    The severity level at which code scanning results that raise alerts block a reference update. Can be one of: none, errors, errors_and_warnings, all.
    security_alerts_threshold str
    The severity level at which code scanning results that raise security alerts block a reference update. Can be one of: none, critical, high_or_higher, medium_or_higher, all.
    tool str
    The name of a code scanning tool.
    alertsThreshold String
    The severity level at which code scanning results that raise alerts block a reference update. Can be one of: none, errors, errors_and_warnings, all.
    securityAlertsThreshold String
    The severity level at which code scanning results that raise security alerts block a reference update. Can be one of: none, critical, high_or_higher, medium_or_higher, all.
    tool String
    The name of a code scanning tool.

    OrganizationRulesetRulesRequiredStatusChecks, OrganizationRulesetRulesRequiredStatusChecksArgs

    RequiredChecks List<OrganizationRulesetRulesRequiredStatusChecksRequiredCheck>
    Status checks that are required. Several can be defined.
    StrictRequiredStatusChecksPolicy bool
    Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. Defaults to false.
    RequiredChecks []OrganizationRulesetRulesRequiredStatusChecksRequiredCheck
    Status checks that are required. Several can be defined.
    StrictRequiredStatusChecksPolicy bool
    Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. Defaults to false.
    requiredChecks List<OrganizationRulesetRulesRequiredStatusChecksRequiredCheck>
    Status checks that are required. Several can be defined.
    strictRequiredStatusChecksPolicy Boolean
    Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. Defaults to false.
    requiredChecks OrganizationRulesetRulesRequiredStatusChecksRequiredCheck[]
    Status checks that are required. Several can be defined.
    strictRequiredStatusChecksPolicy boolean
    Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. Defaults to false.
    required_checks Sequence[OrganizationRulesetRulesRequiredStatusChecksRequiredCheck]
    Status checks that are required. Several can be defined.
    strict_required_status_checks_policy bool
    Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. Defaults to false.
    requiredChecks List<Property Map>
    Status checks that are required. Several can be defined.
    strictRequiredStatusChecksPolicy Boolean
    Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. Defaults to false.

    OrganizationRulesetRulesRequiredStatusChecksRequiredCheck, OrganizationRulesetRulesRequiredStatusChecksRequiredCheckArgs

    Context string
    The status check context name that must be present on the commit.
    IntegrationId int
    The optional integration ID that this status check must originate from.
    Context string
    The status check context name that must be present on the commit.
    IntegrationId int
    The optional integration ID that this status check must originate from.
    context String
    The status check context name that must be present on the commit.
    integrationId Integer
    The optional integration ID that this status check must originate from.
    context string
    The status check context name that must be present on the commit.
    integrationId number
    The optional integration ID that this status check must originate from.
    context str
    The status check context name that must be present on the commit.
    integration_id int
    The optional integration ID that this status check must originate from.
    context String
    The status check context name that must be present on the commit.
    integrationId Number
    The optional integration ID that this status check must originate from.

    OrganizationRulesetRulesRequiredWorkflows, OrganizationRulesetRulesRequiredWorkflowsArgs

    RequiredWorkflows List<OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow>
    Actions workflows that are required. Several can be defined.
    RequiredWorkflows []OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow
    Actions workflows that are required. Several can be defined.
    requiredWorkflows List<OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow>
    Actions workflows that are required. Several can be defined.
    requiredWorkflows OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow[]
    Actions workflows that are required. Several can be defined.
    required_workflows Sequence[OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow]
    Actions workflows that are required. Several can be defined.
    requiredWorkflows List<Property Map>
    Actions workflows that are required. Several can be defined.

    OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflow, OrganizationRulesetRulesRequiredWorkflowsRequiredWorkflowArgs

    Path string
    The path to the workflow YAML definition file.
    RepositoryId int
    The repository in which the workflow is defined.
    Ref string
    The ref (branch or tag) of the workflow file to use.
    Path string
    The path to the workflow YAML definition file.
    RepositoryId int
    The repository in which the workflow is defined.
    Ref string
    The ref (branch or tag) of the workflow file to use.
    path String
    The path to the workflow YAML definition file.
    repositoryId Integer
    The repository in which the workflow is defined.
    ref String
    The ref (branch or tag) of the workflow file to use.
    path string
    The path to the workflow YAML definition file.
    repositoryId number
    The repository in which the workflow is defined.
    ref string
    The ref (branch or tag) of the workflow file to use.
    path str
    The path to the workflow YAML definition file.
    repository_id int
    The repository in which the workflow is defined.
    ref str
    The ref (branch or tag) of the workflow file to use.
    path String
    The path to the workflow YAML definition file.
    repositoryId Number
    The repository in which the workflow is defined.
    ref String
    The ref (branch or tag) of the workflow file to use.

    OrganizationRulesetRulesTagNamePattern, OrganizationRulesetRulesTagNamePatternArgs

    Operator string
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    Pattern string
    The pattern to match with.
    Name string
    (String) The name of the ruleset.
    Negate bool
    If true, the rule will fail if the pattern matches.
    Operator string
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    Pattern string
    The pattern to match with.
    Name string
    (String) The name of the ruleset.
    Negate bool
    If true, the rule will fail if the pattern matches.
    operator String
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern String
    The pattern to match with.
    name String
    (String) The name of the ruleset.
    negate Boolean
    If true, the rule will fail if the pattern matches.
    operator string
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern string
    The pattern to match with.
    name string
    (String) The name of the ruleset.
    negate boolean
    If true, the rule will fail if the pattern matches.
    operator str
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern str
    The pattern to match with.
    name str
    (String) The name of the ruleset.
    negate bool
    If true, the rule will fail if the pattern matches.
    operator String
    The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.
    pattern String
    The pattern to match with.
    name String
    (String) The name of the ruleset.
    negate Boolean
    If true, the rule will fail if the pattern matches.

    Import

    GitHub Organization Rulesets can be imported using the GitHub ruleset ID e.g.

    $ pulumi import github:index/organizationRuleset:OrganizationRuleset example 12345`

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    GitHub pulumi/pulumi-github
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the github Terraform Provider.
    github logo
    GitHub v6.7.0 published on Friday, Feb 28, 2025 by Pulumi
    pulumi/pulumi-github