OrganizationRulesetRules

data class OrganizationRulesetRules(val branchNamePattern: OrganizationRulesetRulesBranchNamePattern? = null, val commitAuthorEmailPattern: OrganizationRulesetRulesCommitAuthorEmailPattern? = null, val commitMessagePattern: OrganizationRulesetRulesCommitMessagePattern? = null, val committerEmailPattern: OrganizationRulesetRulesCommitterEmailPattern? = null, val creation: Boolean? = null, val deletion: Boolean? = null, val nonFastForward: Boolean? = null, val pullRequest: OrganizationRulesetRulesPullRequest? = null, val requiredLinearHistory: Boolean? = null, val requiredSignatures: Boolean? = null, val requiredStatusChecks: OrganizationRulesetRulesRequiredStatusChecks? = null, val requiredWorkflows: OrganizationRulesetRulesRequiredWorkflows? = null, val tagNamePattern: OrganizationRulesetRulesTagNamePattern? = null, val update: Boolean? = null)

Constructors

Link copied to clipboard
constructor(branchNamePattern: OrganizationRulesetRulesBranchNamePattern? = null, commitAuthorEmailPattern: OrganizationRulesetRulesCommitAuthorEmailPattern? = null, commitMessagePattern: OrganizationRulesetRulesCommitMessagePattern? = null, committerEmailPattern: OrganizationRulesetRulesCommitterEmailPattern? = null, creation: Boolean? = null, deletion: Boolean? = null, nonFastForward: Boolean? = null, pullRequest: OrganizationRulesetRulesPullRequest? = null, requiredLinearHistory: Boolean? = null, requiredSignatures: Boolean? = null, requiredStatusChecks: OrganizationRulesetRulesRequiredStatusChecks? = null, requiredWorkflows: OrganizationRulesetRulesRequiredWorkflows? = null, tagNamePattern: OrganizationRulesetRulesTagNamePattern? = null, update: Boolean? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val creation: Boolean? = null

(Boolean) Only allow users with bypass permission to create matching refs.

Link copied to clipboard
val deletion: Boolean? = null

(Boolean) Only allow users with bypass permissions to delete matching refs.

Link copied to clipboard
val nonFastForward: Boolean? = null

(Boolean) Prevent users with push access from force pushing to branches.

Link copied to clipboard

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

Link copied to clipboard

(Boolean) Prevent merge commits from being pushed to matching branches.

Link copied to clipboard

(Boolean) Commits pushed to matching branches must have verified signatures.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val update: Boolean? = null

(Boolean) Only allow users with bypass permission to update matching refs.