Skip to main content
REST API 现已经过版本控制。 有关详细信息,请参阅“关于 API 版本控制”。

规则的 REST API 终结点

使用 REST API 管理存储库的规则集。 规则集控制用户如何与存储库中的选定分支和标记交互。

Get rules for a branch

Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" enforcement statuses are not returned.

“Get rules for a branch”的细粒度访问令牌

此端点支持以下精细令牌类型:

精细令牌必须具有以下权限集:

  • "Metadata" repository permissions (read)

如果仅请求公共资源,则无需身份验证或上述权限即可使用此终结点。

“Get rules for a branch”的参数

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

路径参数
名称, 类型, 说明
owner string 必须

The account owner of the repository. The name is not case sensitive.

repo string 必须

The name of the repository without the .git extension. The name is not case sensitive.

branch string 必须

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

查询参数
名称, 类型, 说明
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

默认: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

默认: 1

“Get rules for a branch”的 HTTP 响应状态代码

状态代码说明
200

OK

“Get rules for a branch”的示例代码

请求示例

get/repos/{owner}/{repo}/rules/branches/{branch}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/rules/branches/BRANCH

Response

Status: 200
[ { "type": "commit_message_pattern", "ruleset_source_type": "Repository", "ruleset_source": "monalisa/my-repo", "ruleset_id": 42, "parameters": { "operator": "starts_with", "pattern": "issue" } }, { "type": "commit_author_email_pattern", "ruleset_source_type": "Organization", "ruleset_source": "my-org", "ruleset_id": 73, "parameters": { "operator": "contains", "pattern": "github" } } ]

Get all repository rulesets

Get all the rulesets for a repository.

“Get all repository rulesets”的细粒度访问令牌

此端点支持以下精细令牌类型:

精细令牌必须具有以下权限集:

  • "Metadata" repository permissions (read)

如果仅请求公共资源,则无需身份验证或上述权限即可使用此终结点。

“Get all repository rulesets”的参数

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

路径参数
名称, 类型, 说明
owner string 必须

The account owner of the repository. The name is not case sensitive.

repo string 必须

The name of the repository without the .git extension. The name is not case sensitive.

查询参数
名称, 类型, 说明
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

默认: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

默认: 1

includes_parents boolean

Include rulesets configured at higher levels that apply to this repository

默认: true

“Get all repository rulesets”的 HTTP 响应状态代码

状态代码说明
200

OK

404

Resource not found

500

Internal Error

“Get all repository rulesets”的示例代码

请求示例

get/repos/{owner}/{repo}/rulesets
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/rulesets

Response

Status: 200
[ { "id": 42, "name": "super cool ruleset", "source_type": "Repository", "source": "monalisa/my-repo", "enforcement": "enabled", "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" }, "html": { "href": "https://github.com/monalisa/my-repo/rules/42" } }, "created_at": "2023-07-15T08:43:03Z", "updated_at": "2023-08-23T16:29:47Z" }, { "id": 314, "name": "Another ruleset", "source_type": "Repository", "source": "monalisa/my-repo", "enforcement": "enabled", "node_id": "RRS_lACkVXNlcgQQ", "_links": { "self": { "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/314" }, "html": { "href": "https://github.com/monalisa/my-repo/rules/314" } }, "created_at": "2023-08-15T08:43:03Z", "updated_at": "2023-09-23T16:29:47Z" } ]

Create a repository ruleset

Create a ruleset for a repository.

“Create a repository ruleset”的细粒度访问令牌

此端点支持以下精细令牌类型:

精细令牌必须具有以下权限集:

  • "Administration" repository permissions (write)

“Create a repository ruleset”的参数

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

路径参数
名称, 类型, 说明
owner string 必须

The account owner of the repository. The name is not case sensitive.

repo string 必须

The name of the repository without the .git extension. The name is not case sensitive.

正文参数
名称, 类型, 说明
name string 必须

The name of the ruleset.

target string

The target of the ruleset

Note: The push target is in beta and is subject to change.

可以是以下选项之一: branch, tag, push

enforcement string 必须

The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (evaluate is only available with GitHub Enterprise).

可以是以下选项之一: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

名称, 类型, 说明
actor_id integer or null

The ID of the actor that can bypass a ruleset. If actor_type is OrganizationAdmin, this should be 1. If actor_type is DeployKey, this should be null. OrganizationAdmin is not applicable for personal repositories.

actor_type string 必须

The type of actor that can bypass a ruleset.

可以是以下选项之一: Integration, OrganizationAdmin, RepositoryRole, Team, DeployKey

bypass_mode string 必须

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type.

可以是以下选项之一: always, pull_request

conditions object

Parameters for a repository ruleset ref name condition

名称, 类型, 说明
ref_name object
名称, 类型, 说明
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

rules array of objects

An array of rules within the ruleset.

名称, 类型, 说明
creation object 必须

Only allow users with bypass permission to create matching refs.

名称, 类型, 说明
type string 必须

: creation

update object 必须

Only allow users with bypass permission to update matching refs.

名称, 类型, 说明
type string 必须

: update

parameters object
名称, 类型, 说明
update_allows_fetch_and_merge boolean 必须

Branch can pull changes from its upstream repository

deletion object 必须

Only allow users with bypass permissions to delete matching refs.

名称, 类型, 说明
type string 必须

: deletion

required_linear_history object 必须

Prevent merge commits from being pushed to matching refs.

名称, 类型, 说明
type string 必须

: required_linear_history

required_deployments object 必须

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

名称, 类型, 说明
type string 必须

: required_deployments

parameters object
名称, 类型, 说明
required_deployment_environments array of strings 必须

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

required_signatures object 必须

Commits pushed to matching refs must have verified signatures.

名称, 类型, 说明
type string 必须

: required_signatures

pull_request object 必须

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

名称, 类型, 说明
type string 必须

: pull_request

parameters object
名称, 类型, 说明
dismiss_stale_reviews_on_push boolean 必须

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

require_code_owner_review boolean 必须

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

require_last_push_approval boolean 必须

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

required_approving_review_count integer 必须

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

required_review_thread_resolution boolean 必须

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

required_status_checks object 必须

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.

名称, 类型, 说明
type string 必须

: required_status_checks

parameters object
名称, 类型, 说明
required_status_checks array of objects 必须

Status checks that are required.

名称, 类型, 说明
context string 必须

The status check context name that must be present on the commit.

integration_id integer

The optional integration ID that this status check must originate from.

strict_required_status_checks_policy 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.

non_fast_forward object 必须

Prevent users with push access from force pushing to refs.

名称, 类型, 说明
type string 必须

: non_fast_forward

commit_message_pattern object 必须

Parameters to be used for the commit_message_pattern rule

名称, 类型, 说明
type string 必须

: commit_message_pattern

parameters object
名称, 类型, 说明
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.

可以是以下选项之一: starts_with, ends_with, contains, regex

pattern string 必须

The pattern to match with.

commit_author_email_pattern object 必须

Parameters to be used for the commit_author_email_pattern rule

名称, 类型, 说明
type string 必须

: commit_author_email_pattern

parameters object
名称, 类型, 说明
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.

可以是以下选项之一: starts_with, ends_with, contains, regex

pattern string 必须

The pattern to match with.

committer_email_pattern object 必须

Parameters to be used for the committer_email_pattern rule

名称, 类型, 说明
type string 必须

: committer_email_pattern

parameters object
名称, 类型, 说明
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.

可以是以下选项之一: starts_with, ends_with, contains, regex

pattern string 必须

The pattern to match with.

branch_name_pattern object 必须

Parameters to be used for the branch_name_pattern rule

名称, 类型, 说明
type string 必须

: branch_name_pattern

parameters object
名称, 类型, 说明
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.

可以是以下选项之一: starts_with, ends_with, contains, regex

pattern string 必须

The pattern to match with.

tag_name_pattern object 必须

Parameters to be used for the tag_name_pattern rule

名称, 类型, 说明
type string 必须

: tag_name_pattern

parameters object
名称, 类型, 说明
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.

可以是以下选项之一: starts_with, ends_with, contains, regex

pattern string 必须

The pattern to match with.

file_path_restriction object 必须

Note: file_path_restriction is in beta and subject to change.

Prevent commits that include changes in specified file paths from being pushed to the commit graph.

名称, 类型, 说明
type string 必须

: file_path_restriction

parameters object
名称, 类型, 说明
restricted_file_paths array of strings 必须

The file paths that are restricted from being pushed to the commit graph.

max_file_path_length object 必须

Note: max_file_path_length is in beta and subject to change.

Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.

名称, 类型, 说明
type string 必须

: max_file_path_length

parameters object
名称, 类型, 说明
max_file_path_length integer 必须

The maximum amount of characters allowed in file paths

file_extension_restriction object 必须

Note: file_extension_restriction is in beta and subject to change.

Prevent commits that include files with specified file extensions from being pushed to the commit graph.

名称, 类型, 说明
type string 必须

: file_extension_restriction

parameters object
名称, 类型, 说明
restricted_file_extensions array of strings 必须

The file extensions that are restricted from being pushed to the commit graph.

max_file_size object 必须

Note: max_file_size is in beta and subject to change.

Prevent commits that exceed a specified file size limit from being pushed to the commit.

名称, 类型, 说明
type string 必须

: max_file_size

parameters object
名称, 类型, 说明
max_file_size integer 必须

The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).

workflows object 必须

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

名称, 类型, 说明
type string 必须

: workflows

parameters object
名称, 类型, 说明
workflows array of objects 必须

Workflows that must pass for this rule to pass.

名称, 类型, 说明
path string 必须

The path to the workflow file

ref string

The ref (branch or tag) of the workflow file to use

repository_id integer 必须

The ID of the repository where the workflow is defined

sha string

The commit SHA of the workflow file to use

code_scanning object 必须

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.

名称, 类型, 说明
type string 必须

: code_scanning

parameters object
名称, 类型, 说明
code_scanning_tools array of objects 必须

Tools that must provide code scanning results for this rule to pass.

名称, 类型, 说明
alerts_threshold string 必须

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts."

可以是以下选项之一: none, errors, errors_and_warnings, all

security_alerts_threshold string 必须

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts."

可以是以下选项之一: none, critical, high_or_higher, medium_or_higher, all

tool string 必须

The name of a code scanning tool

“Create a repository ruleset”的 HTTP 响应状态代码

状态代码说明
201

Created

404

Resource not found

500

Internal Error

“Create a repository ruleset”的示例代码

请求示例

post/repos/{owner}/{repo}/rulesets
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/rulesets \ -d '{"name":"super cool ruleset","target":"branch","enforcement":"active","bypass_actors":[{"actor_id":234,"actor_type":"Team","bypass_mode":"always"}],"conditions":{"ref_name":{"include":["refs/heads/main","refs/heads/master"],"exclude":["refs/heads/dev*"]}},"rules":[{"type":"commit_author_email_pattern","parameters":{"operator":"contains","pattern":"github"}}]}'

Response

Status: 201
{ "id": 42, "name": "super cool ruleset", "target": "branch", "source_type": "Repository", "source": "monalisa/my-repo", "enforcement": "active", "bypass_actors": [ { "actor_id": 234, "actor_type": "Team", "bypass_mode": "always" } ], "conditions": { "ref_name": { "include": [ "refs/heads/main", "refs/heads/master" ], "exclude": [ "refs/heads/dev*" ] } }, "rules": [ { "type": "commit_author_email_pattern", "parameters": { "operator": "contains", "pattern": "github" } } ], "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" }, "html": { "href": "https://github.com/monalisa/my-repo/rules/42" } }, "created_at": "2023-07-15T08:43:03Z", "updated_at": "2023-08-23T16:29:47Z" }

Get a repository ruleset

Get a ruleset for a repository.

“Get a repository ruleset”的细粒度访问令牌

此端点支持以下精细令牌类型:

精细令牌必须具有以下权限集:

  • "Metadata" repository permissions (read)

如果仅请求公共资源,则无需身份验证或上述权限即可使用此终结点。

“Get a repository ruleset”的参数

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

路径参数
名称, 类型, 说明
owner string 必须

The account owner of the repository. The name is not case sensitive.

repo string 必须

The name of the repository without the .git extension. The name is not case sensitive.

ruleset_id integer 必须

The ID of the ruleset.

查询参数
名称, 类型, 说明
includes_parents boolean

Include rulesets configured at higher levels that apply to this repository

默认: true

“Get a repository ruleset”的 HTTP 响应状态代码

状态代码说明
200

OK

404

Resource not found

500

Internal Error

“Get a repository ruleset”的示例代码

请求示例

get/repos/{owner}/{repo}/rulesets/{ruleset_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/rulesets/RULESET_ID

Response

Status: 200
{ "id": 42, "name": "super cool ruleset", "target": "branch", "source_type": "Repository", "source": "monalisa/my-repo", "enforcement": "active", "bypass_actors": [ { "actor_id": 234, "actor_type": "Team", "bypass_mode": "always" } ], "conditions": { "ref_name": { "include": [ "refs/heads/main", "refs/heads/master" ], "exclude": [ "refs/heads/dev*" ] } }, "rules": [ { "type": "commit_author_email_pattern", "parameters": { "operator": "contains", "pattern": "github" } } ], "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" }, "html": { "href": "https://github.com/monalisa/my-repo/rules/42" } }, "created_at": "2023-07-15T08:43:03Z", "updated_at": "2023-08-23T16:29:47Z" }

Update a repository ruleset

Update a ruleset for a repository.

“Update a repository ruleset”的细粒度访问令牌

此端点支持以下精细令牌类型:

精细令牌必须具有以下权限集:

  • "Administration" repository permissions (write)

“Update a repository ruleset”的参数

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

路径参数
名称, 类型, 说明
owner string 必须

The account owner of the repository. The name is not case sensitive.

repo string 必须

The name of the repository without the .git extension. The name is not case sensitive.

ruleset_id integer 必须

The ID of the ruleset.

正文参数
名称, 类型, 说明
name string

The name of the ruleset.

target string

The target of the ruleset

Note: The push target is in beta and is subject to change.

可以是以下选项之一: branch, tag, push

enforcement string

The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (evaluate is only available with GitHub Enterprise).

可以是以下选项之一: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

名称, 类型, 说明
actor_id integer or null

The ID of the actor that can bypass a ruleset. If actor_type is OrganizationAdmin, this should be 1. If actor_type is DeployKey, this should be null. OrganizationAdmin is not applicable for personal repositories.

actor_type string 必须

The type of actor that can bypass a ruleset.

可以是以下选项之一: Integration, OrganizationAdmin, RepositoryRole, Team, DeployKey

bypass_mode string 必须

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type.

可以是以下选项之一: always, pull_request

conditions object

Parameters for a repository ruleset ref name condition

名称, 类型, 说明
ref_name object
名称, 类型, 说明
include array of strings

Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

rules array of objects

An array of rules within the ruleset.

名称, 类型, 说明
creation object 必须

Only allow users with bypass permission to create matching refs.

名称, 类型, 说明
type string 必须

: creation

update object 必须

Only allow users with bypass permission to update matching refs.

名称, 类型, 说明
type string 必须

: update

parameters object
名称, 类型, 说明
update_allows_fetch_and_merge boolean 必须

Branch can pull changes from its upstream repository

deletion object 必须

Only allow users with bypass permissions to delete matching refs.

名称, 类型, 说明
type string 必须

: deletion

required_linear_history object 必须

Prevent merge commits from being pushed to matching refs.

名称, 类型, 说明
type string 必须

: required_linear_history

required_deployments object 必须

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

名称, 类型, 说明
type string 必须

: required_deployments

parameters object
名称, 类型, 说明
required_deployment_environments array of strings 必须

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

required_signatures object 必须

Commits pushed to matching refs must have verified signatures.

名称, 类型, 说明
type string 必须

: required_signatures

pull_request object 必须

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

名称, 类型, 说明
type string 必须

: pull_request

parameters object
名称, 类型, 说明
dismiss_stale_reviews_on_push boolean 必须

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

require_code_owner_review boolean 必须

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

require_last_push_approval boolean 必须

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

required_approving_review_count integer 必须

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

required_review_thread_resolution boolean 必须

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

required_status_checks object 必须

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.

名称, 类型, 说明
type string 必须

: required_status_checks

parameters object
名称, 类型, 说明
required_status_checks array of objects 必须

Status checks that are required.

名称, 类型, 说明
context string 必须

The status check context name that must be present on the commit.

integration_id integer

The optional integration ID that this status check must originate from.

strict_required_status_checks_policy 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.

non_fast_forward object 必须

Prevent users with push access from force pushing to refs.

名称, 类型, 说明
type string 必须

: non_fast_forward

commit_message_pattern object 必须

Parameters to be used for the commit_message_pattern rule

名称, 类型, 说明
type string 必须

: commit_message_pattern

parameters object
名称, 类型, 说明
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.

可以是以下选项之一: starts_with, ends_with, contains, regex

pattern string 必须

The pattern to match with.

commit_author_email_pattern object 必须

Parameters to be used for the commit_author_email_pattern rule

名称, 类型, 说明
type string 必须

: commit_author_email_pattern

parameters object
名称, 类型, 说明
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.

可以是以下选项之一: starts_with, ends_with, contains, regex

pattern string 必须

The pattern to match with.

committer_email_pattern object 必须

Parameters to be used for the committer_email_pattern rule

名称, 类型, 说明
type string 必须

: committer_email_pattern

parameters object
名称, 类型, 说明
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.

可以是以下选项之一: starts_with, ends_with, contains, regex

pattern string 必须

The pattern to match with.

branch_name_pattern object 必须

Parameters to be used for the branch_name_pattern rule

名称, 类型, 说明
type string 必须

: branch_name_pattern

parameters object
名称, 类型, 说明
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.

可以是以下选项之一: starts_with, ends_with, contains, regex

pattern string 必须

The pattern to match with.

tag_name_pattern object 必须

Parameters to be used for the tag_name_pattern rule

名称, 类型, 说明
type string 必须

: tag_name_pattern

parameters object
名称, 类型, 说明
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.

可以是以下选项之一: starts_with, ends_with, contains, regex

pattern string 必须

The pattern to match with.

file_path_restriction object 必须

Note: file_path_restriction is in beta and subject to change.

Prevent commits that include changes in specified file paths from being pushed to the commit graph.

名称, 类型, 说明
type string 必须

: file_path_restriction

parameters object
名称, 类型, 说明
restricted_file_paths array of strings 必须

The file paths that are restricted from being pushed to the commit graph.

max_file_path_length object 必须

Note: max_file_path_length is in beta and subject to change.

Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.

名称, 类型, 说明
type string 必须

: max_file_path_length

parameters object
名称, 类型, 说明
max_file_path_length integer 必须

The maximum amount of characters allowed in file paths

file_extension_restriction object 必须

Note: file_extension_restriction is in beta and subject to change.

Prevent commits that include files with specified file extensions from being pushed to the commit graph.

名称, 类型, 说明
type string 必须

: file_extension_restriction

parameters object
名称, 类型, 说明
restricted_file_extensions array of strings 必须

The file extensions that are restricted from being pushed to the commit graph.

max_file_size object 必须

Note: max_file_size is in beta and subject to change.

Prevent commits that exceed a specified file size limit from being pushed to the commit.

名称, 类型, 说明
type string 必须

: max_file_size

parameters object
名称, 类型, 说明
max_file_size integer 必须

The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).

workflows object 必须

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

名称, 类型, 说明
type string 必须

: workflows

parameters object
名称, 类型, 说明
workflows array of objects 必须

Workflows that must pass for this rule to pass.

名称, 类型, 说明
path string 必须

The path to the workflow file

ref string

The ref (branch or tag) of the workflow file to use

repository_id integer 必须

The ID of the repository where the workflow is defined

sha string

The commit SHA of the workflow file to use

code_scanning object 必须

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.

名称, 类型, 说明
type string 必须

: code_scanning

parameters object
名称, 类型, 说明
code_scanning_tools array of objects 必须

Tools that must provide code scanning results for this rule to pass.

名称, 类型, 说明
alerts_threshold string 必须

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts."

可以是以下选项之一: none, errors, errors_and_warnings, all

security_alerts_threshold string 必须

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts."

可以是以下选项之一: none, critical, high_or_higher, medium_or_higher, all

tool string 必须

The name of a code scanning tool

“Update a repository ruleset”的 HTTP 响应状态代码

状态代码说明
200

OK

404

Resource not found

500

Internal Error

“Update a repository ruleset”的示例代码

请求示例

put/repos/{owner}/{repo}/rulesets/{ruleset_id}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/rulesets/RULESET_ID \ -d '{"name":"super cool ruleset","target":"branch","enforcement":"active","bypass_actors":[{"actor_id":234,"actor_type":"Team","bypass_mode":"always"}],"conditions":{"ref_name":{"include":["refs/heads/main","refs/heads/master"],"exclude":["refs/heads/dev*"]}},"rules":[{"type":"commit_author_email_pattern","parameters":{"operator":"contains","pattern":"github"}}]}'

Response

Status: 200
{ "id": 42, "name": "super cool ruleset", "target": "branch", "source_type": "Repository", "source": "monalisa/my-repo", "enforcement": "active", "bypass_actors": [ { "actor_id": 234, "actor_type": "Team", "bypass_mode": "always" } ], "conditions": { "ref_name": { "include": [ "refs/heads/main", "refs/heads/master" ], "exclude": [ "refs/heads/dev*" ] } }, "rules": [ { "type": "commit_author_email_pattern", "parameters": { "operator": "contains", "pattern": "github" } } ], "node_id": "RRS_lACkVXNlcgQB", "_links": { "self": { "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" }, "html": { "href": "https://github.com/monalisa/my-repo/rules/42" } }, "created_at": "2023-07-15T08:43:03Z", "updated_at": "2023-08-23T16:29:47Z" }

Delete a repository ruleset

Delete a ruleset for a repository.

“Delete a repository ruleset”的细粒度访问令牌

此端点支持以下精细令牌类型:

精细令牌必须具有以下权限集:

  • "Administration" repository permissions (write)

“Delete a repository ruleset”的参数

标头
名称, 类型, 说明
accept string

Setting to application/vnd.github+json is recommended.

路径参数
名称, 类型, 说明
owner string 必须

The account owner of the repository. The name is not case sensitive.

repo string 必须

The name of the repository without the .git extension. The name is not case sensitive.

ruleset_id integer 必须

The ID of the ruleset.

“Delete a repository ruleset”的 HTTP 响应状态代码

状态代码说明
204

No Content

404

Resource not found

500

Internal Error

“Delete a repository ruleset”的示例代码

请求示例

delete/repos/{owner}/{repo}/rulesets/{ruleset_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/rulesets/RULESET_ID

Response

Status: 204