github.OrganizationRuleset

Coming soon!

Coming soon!

Coming soon!

Coming soon!

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.

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.

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.

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.

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:

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:

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:

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:

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:

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:

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.

Excludes List<string>

(List of String) Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

Includes List<string>

(List of 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.

Excludes []string

(List of String) Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

Includes []string

(List of 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.

excludes List<String>

(List of String) Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

includes List<String>

(List of 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.

excludes string[]

(List of String) Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

includes string[]

(List of 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.

excludes Sequence[str]

(List of String) Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

includes Sequence[str]

(List of 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.

excludes List<String>

(List of String) Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

includes List<String>

(List of 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.

Excludes List<string>

(List of String) Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

Includes List<string>

(List of 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

(List of String) Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

Includes []string

(List of 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>

(List of String) Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

includes List<String>

(List of 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[]

(List of String) Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

includes string[]

(List of 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]

(List of String) Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

includes Sequence[str]

(List of 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>

(List of String) Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.

includes List<String>

(List of 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.

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)

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)

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)

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)

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_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)

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.

Operator string

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

Pattern string

(String) The pattern to match with.

Name string

(String) The name of the ruleset.

Negate bool

(Boolean) If true, the rule will fail if the pattern matches.

Operator string

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

Pattern string

(String) The pattern to match with.

Name string

(String) The name of the ruleset.

Negate bool

(Boolean) If true, the rule will fail if the pattern matches.

operator String

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

pattern String

(String) The pattern to match with.

name String

(String) The name of the ruleset.

negate Boolean

(Boolean) If true, the rule will fail if the pattern matches.

operator string

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

pattern string

(String) The pattern to match with.

name string

(String) The name of the ruleset.

negate boolean

(Boolean) If true, the rule will fail if the pattern matches.

operator str

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

pattern str

(String) The pattern to match with.

name str

(String) The name of the ruleset.

negate bool

(Boolean) If true, the rule will fail if the pattern matches.

operator String

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

pattern String

(String) The pattern to match with.

name String

(String) The name of the ruleset.

negate Boolean

(Boolean) If true, the rule will fail if the pattern matches.

Operator string

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

Pattern string

(String) The pattern to match with.

Name string

(String) The name of the ruleset.

Negate bool

(Boolean) If true, the rule will fail if the pattern matches.

Operator string

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

Pattern string

(String) The pattern to match with.

Name string

(String) The name of the ruleset.

Negate bool

(Boolean) If true, the rule will fail if the pattern matches.

operator String

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

pattern String

(String) The pattern to match with.

name String

(String) The name of the ruleset.

negate Boolean

(Boolean) If true, the rule will fail if the pattern matches.

operator string

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

pattern string

(String) The pattern to match with.

name string

(String) The name of the ruleset.

negate boolean

(Boolean) If true, the rule will fail if the pattern matches.

operator str

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

pattern str

(String) The pattern to match with.

name str

(String) The name of the ruleset.

negate bool

(Boolean) If true, the rule will fail if the pattern matches.

operator String

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

pattern String

(String) The pattern to match with.

name String

(String) The name of the ruleset.

negate Boolean

(Boolean) If true, the rule will fail if the pattern matches.

Operator string

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

Pattern string

(String) The pattern to match with.

Name string

(String) The name of the ruleset.

Negate bool

(Boolean) If true, the rule will fail if the pattern matches.

Operator string

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

Pattern string

(String) The pattern to match with.

Name string

(String) The name of the ruleset.

Negate bool

(Boolean) If true, the rule will fail if the pattern matches.

operator String

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

pattern String

(String) The pattern to match with.

name String

(String) The name of the ruleset.

negate Boolean

(Boolean) If true, the rule will fail if the pattern matches.

operator string

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

pattern string

(String) The pattern to match with.

name string

(String) The name of the ruleset.

negate boolean

(Boolean) If true, the rule will fail if the pattern matches.

operator str

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

pattern str

(String) The pattern to match with.

name str

(String) The name of the ruleset.

negate bool

(Boolean) If true, the rule will fail if the pattern matches.

operator String

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

pattern String

(String) The pattern to match with.

name String

(String) The name of the ruleset.

negate Boolean

(Boolean) If true, the rule will fail if the pattern matches.

Operator string

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

Pattern string

(String) The pattern to match with.

Name string

(String) The name of the ruleset.

Negate bool

(Boolean) If true, the rule will fail if the pattern matches.

Operator string

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

Pattern string

(String) The pattern to match with.

Name string

(String) The name of the ruleset.

Negate bool

(Boolean) If true, the rule will fail if the pattern matches.

operator String

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

pattern String

(String) The pattern to match with.

name String

(String) The name of the ruleset.

negate Boolean

(Boolean) If true, the rule will fail if the pattern matches.

operator string

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

pattern string

(String) The pattern to match with.

name string

(String) The name of the ruleset.

negate boolean

(Boolean) If true, the rule will fail if the pattern matches.

operator str

(String) The operator to use for matching. Can be one of: starts_with, ends_with, contains, regex.

pattern str

(String) The pattern to match with.

name str

(String) The name of the ruleset.

negate bool

(Boolean) If true, the rule will fail if the pattern matches.