RepositoryRuleType Enum
The rule types supported in rulesets
Possible Values
#
AUTHORIZATION
Authorization
BRANCH_NAME_PATTERN
Branch name pattern
CODE_SCANNING
Choose 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.
COMMITTER_EMAIL_PATTERN
Committer email pattern
COMMIT_AUTHOR_EMAIL_PATTERN
Commit author email pattern
COMMIT_MESSAGE_PATTERN
Commit message pattern
CREATION
Only allow users with bypass permission to create matching refs.
DELETION
Only allow users with bypass permissions to delete matching refs.
FILE_EXTENSION_RESTRICTION
Prevent commits that include files with specified file extensions from being pushed to the commit graph. NOTE: This rule is in beta and subject to change
FILE_PATH_RESTRICTION
Prevent commits that include changes in specified file paths from being pushed to the commit graph. NOTE: This rule is in beta and subject to change
LOCK_BRANCH
Branch is read-only. Users cannot push to the branch.
MAX_FILE_PATH_LENGTH
Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph. NOTE: This rule is in beta and subject to change
MAX_FILE_SIZE
Prevent commits that exceed a specified file size limit from being pushed to the commit. NOTE: This rule is in beta and subject to change
MAX_REF_UPDATES
Max ref updates
MERGE_QUEUE
Merges must be performed via a merge queue.
MERGE_QUEUE_LOCKED_REF
Merge queue locked ref
NON_FAST_FORWARD
Prevent users with push access from force pushing to refs.
PULL_REQUEST
Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
REQUIRED_DEPLOYMENTS
Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
REQUIRED_LINEAR_HISTORY
Prevent merge commits from being pushed to matching refs.
REQUIRED_REVIEW_THREAD_RESOLUTION
When enabled, all conversations on code must be resolved before a pull request can be merged into a branch that matches this rule.
REQUIRED_SIGNATURES
Commits pushed to matching refs must have verified signatures.
REQUIRED_STATUS_CHECKS
Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.
REQUIRED_WORKFLOW_STATUS_CHECKS
Require all commits be made to a non-target branch and submitted via a pull request and required workflow checks to pass before they can be merged.
SECRET_SCANNING
Secret scanning
TAG
Tag
TAG_NAME_PATTERN
Tag name pattern
UPDATE
Only allow users with bypass permission to update matching refs.
WORKFLOWS
Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
WORKFLOW_UPDATES
Workflow files cannot be modified.
Usages
#
References
#
- Field type from RepositoryRule
- Argument type of field rules from type RepositoryRuleset
RepositoryRuleOrderField
RepositoryRuleset
