Github API - Test Config

RepositoryRule [object]

A repository rule.

Implements
Node

Node [interface]

An object with an ID.

Attributes
id ID

ID of the object.

API:
Github GraphQL API
Attributes
id ID

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.

API:
Github GraphQL API

The Node ID of the RepositoryRule object

repositoryRuleset RepositoryRuleset

RepositoryRuleset [object]

A repository ruleset.

Implements
Node
Attributes

The actors that can bypass this ruleset

The set of conditions that must evaluate to true for this ruleset to apply

createdAt DateTime

Identifies the date and time when the object was created.

databaseId Int

Identifies the primary key from the database.

enforcement RuleEnforcement

The enforcement level of this ruleset

id ID

The Node ID of the RepositoryRuleset object

name String

Name of the ruleset.

List of rules.

source RuleSource

Source of ruleset.

Target of the ruleset.

updatedAt DateTime

Identifies the date and time when the object was last updated.

API:
Github GraphQL API

The repository ruleset associated with this rule configuration

type RepositoryRuleType

RepositoryRuleType [enum]

The rule types supported in rulesets

Possible values
AUTHORIZATION

Authorization

BRANCH_NAME_PATTERN

Branch name pattern

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.

LOCK_BRANCH

Branch is read-only. Users cannot push to the branch.

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.

API:
Github GraphQL API

The type of rule.

API:
Github GraphQL API