RepositoryRulesetRules

data class RepositoryRulesetRules(val branchNamePattern: RepositoryRulesetRulesBranchNamePattern? = null, val commitAuthorEmailPattern: RepositoryRulesetRulesCommitAuthorEmailPattern? = null, val commitMessagePattern: RepositoryRulesetRulesCommitMessagePattern? = null, val committerEmailPattern: RepositoryRulesetRulesCommitterEmailPattern? = null, val creation: Boolean? = null, val deletion: Boolean? = null, val mergeQueue: RepositoryRulesetRulesMergeQueue? = null, val nonFastForward: Boolean? = null, val pullRequest: RepositoryRulesetRulesPullRequest? = null, val requiredCodeScanning: RepositoryRulesetRulesRequiredCodeScanning? = null, val requiredDeployments: RepositoryRulesetRulesRequiredDeployments? = null, val requiredLinearHistory: Boolean? = null, val requiredSignatures: Boolean? = null, val requiredStatusChecks: RepositoryRulesetRulesRequiredStatusChecks? = null, val tagNamePattern: RepositoryRulesetRulesTagNamePattern? = null, val update: Boolean? = null, val updateAllowsFetchAndMerge: Boolean? = null)

Constructors

Link copied to clipboard
constructor(branchNamePattern: RepositoryRulesetRulesBranchNamePattern? = null, commitAuthorEmailPattern: RepositoryRulesetRulesCommitAuthorEmailPattern? = null, commitMessagePattern: RepositoryRulesetRulesCommitMessagePattern? = null, committerEmailPattern: RepositoryRulesetRulesCommitterEmailPattern? = null, creation: Boolean? = null, deletion: Boolean? = null, mergeQueue: RepositoryRulesetRulesMergeQueue? = null, nonFastForward: Boolean? = null, pullRequest: RepositoryRulesetRulesPullRequest? = null, requiredCodeScanning: RepositoryRulesetRulesRequiredCodeScanning? = null, requiredDeployments: RepositoryRulesetRulesRequiredDeployments? = null, requiredLinearHistory: Boolean? = null, requiredSignatures: Boolean? = null, requiredStatusChecks: RepositoryRulesetRulesRequiredStatusChecks? = null, tagNamePattern: RepositoryRulesetRulesTagNamePattern? = null, update: Boolean? = null, updateAllowsFetchAndMerge: 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 applied 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

(Block List, Max: 1) Merges must be performed via a merge queue.

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

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

Link copied to clipboard

(Block List, Max: 1) Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule. (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) 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 applied 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.

Link copied to clipboard

(Boolean) Branch can pull changes from its upstream repository. This is only applicable to forked repositories. Requires update to be set to true. Note: behaviour is affected by a known bug on the GitHub side which may cause issues when using this parameter.