Github API - Test Config

Flexydox

RuleParametersInput [input]

Specifies the parameters for a RepositoryRule object. Only one of the fields should be specified.

Attributes
branchNamePattern BranchNamePatternParametersInput

BranchNamePatternParametersInput [input]

Parameters to be used for the branch_name_pattern rule

Attributes
name String

How this rule will appear to users.

negate Boolean

If true, the rule will fail if the pattern matches.

operator String

The operator to use for matching.

pattern String

The pattern to match with.

API:
Github GraphQL API

Parameters used for the branch_name_pattern rule type

commitAuthorEmailPattern CommitAuthorEmailPatternParametersInput

CommitAuthorEmailPatternParametersInput [input]

Parameters to be used for the commit_author_email_pattern rule

Attributes
name String

How this rule will appear to users.

negate Boolean

If true, the rule will fail if the pattern matches.

operator String

The operator to use for matching.

pattern String

The pattern to match with.

API:
Github GraphQL API

Parameters used for the commit_author_email_pattern rule type

commitMessagePattern CommitMessagePatternParametersInput

CommitMessagePatternParametersInput [input]

Parameters to be used for the commit_message_pattern rule

Attributes
name String

How this rule will appear to users.

negate Boolean

If true, the rule will fail if the pattern matches.

operator String

The operator to use for matching.

pattern String

The pattern to match with.

API:
Github GraphQL API

Parameters used for the commit_message_pattern rule type

committerEmailPattern CommitterEmailPatternParametersInput

CommitterEmailPatternParametersInput [input]

Parameters to be used for the committer_email_pattern rule

Attributes
name String

How this rule will appear to users.

negate Boolean

If true, the rule will fail if the pattern matches.

operator String

The operator to use for matching.

pattern String

The pattern to match with.

API:
Github GraphQL API

Parameters used for the committer_email_pattern rule type

pullRequest PullRequestParametersInput

PullRequestParametersInput [input]

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

Attributes
dismissStaleReviewsOnPush Boolean

New, reviewable commits pushed will dismiss previous pull request review approvals.

requireCodeOwnerReview Boolean

Require an approving review in pull requests that modify files that have a designated code owner.

requireLastPushApproval Boolean

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

requiredApprovingReviewCount Int

The number of approving reviews that are required before a pull request can be merged.

requiredReviewThreadResolution Boolean

All conversations on code must be resolved before a pull request can be merged.

API:
Github GraphQL API

Parameters used for the pull_request rule type

requiredDeployments RequiredDeploymentsParametersInput

RequiredDeploymentsParametersInput [input]

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

Attributes
requiredDeploymentEnvironments String []

The environments that must be successfully deployed to before branches can be merged.

API:
Github GraphQL API

Parameters used for the required_deployments rule type

requiredStatusChecks RequiredStatusChecksParametersInput

RequiredStatusChecksParametersInput [input]

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.

Attributes
requiredStatusChecks StatusCheckConfigurationInput []

Status checks that are required.

strictRequiredStatusChecksPolicy Boolean

Whether pull requests targeting a matching branch must be tested with the
latest code. This setting will not take effect unless at least one status
check is enabled.

API:
Github GraphQL API

Parameters used for the required_status_checks rule type

tagNamePattern TagNamePatternParametersInput

TagNamePatternParametersInput [input]

Parameters to be used for the tag_name_pattern rule

Attributes
name String

How this rule will appear to users.

negate Boolean

If true, the rule will fail if the pattern matches.

operator String

The operator to use for matching.

pattern String

The pattern to match with.

API:
Github GraphQL API

Parameters used for the tag_name_pattern rule type

update UpdateParametersInput

UpdateParametersInput [input]

Only allow users with bypass permission to update matching refs.

Attributes
updateAllowsFetchAndMerge Boolean

Branch can pull changes from its upstream repository

API:
Github GraphQL API

Parameters used for the update rule type

workflows WorkflowsParametersInput

WorkflowsParametersInput [input]

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

Attributes
workflows WorkflowFileReferenceInput []

Workflows that must pass for this rule to pass.

API:
Github GraphQL API

Parameters used for the workflows rule type

API:
Github GraphQL API