RepositoryRule [object]
A repository rule.
Implements
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.
The Node ID of the RepositoryRule object
RuleParameters [union]
Types which can be parameters for RepositoryRule
objects.
Union
The parameters for this rule.
RepositoryRuleset [object]
A repository ruleset.
Implements
Attributes
The actors that can bypass this ruleset
The set of conditions that must evaluate to true for this ruleset to apply
Identifies the date and time when the object was created.
Identifies the primary key from the database.
The enforcement level of this ruleset
The Node ID of the RepositoryRuleset object
Name of the ruleset.
List of rules.
Source of ruleset.
Target of the ruleset.
Identifies the date and time when the object was last updated.
The repository ruleset associated with this rule configuration
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.