RepositoryRuleInput [input]
Specifies the attributes for a new or updated rule.
Attributes
ID [scalar]
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Optional ID of this rule when updating
RuleParametersInput [input]
Specifies the parameters for a RepositoryRule object. Only one of the fields should be specified.
Attributes
Parameters used for the branch_name_pattern rule type
Parameters used for the commit_author_email_pattern rule type
Parameters used for the commit_message_pattern rule type
Parameters used for the committer_email_pattern rule type
Parameters used for the pull_request rule type
Parameters used for the required_deployments rule type
Parameters used for the required_status_checks rule type
Parameters used for the tag_name_pattern rule type
Parameters used for the update rule type
Parameters used for the workflows rule type
The parameters for the rule.
RepositoryRuleType [enum]
The rule types supported in rulesets
Possible values
Authorization
Branch name pattern
Committer email pattern
Commit author email pattern
Commit message pattern
Only allow users with bypass permission to create matching refs.
Only allow users with bypass permissions to delete matching refs.
Branch is read-only. Users cannot push to the branch.
Max ref updates
Merges must be performed via a merge queue.
Merge queue locked ref
Prevent users with push access from force pushing to refs.
Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
Prevent merge commits from being pushed to matching refs.
When enabled, all conversations on code must be resolved before a pull request
can be merged into a branch that matches this rule.
Commits pushed to matching refs must have verified signatures.
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.
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
Tag
Tag name pattern
Only allow users with bypass permission to update matching refs.
Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
Workflow files cannot be modified.
The type of rule to create.