规则 - GitHub 文档

Get all organization repository rulesets

Get all the repository rulesets for an organization.

“Get all organization repository rulesets”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`org` string 必须 The organization name. The name is not case sensitive.

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

状态代码	说明
`200`	OK
`404`	Resource not found
`500`	Internal Error

“Get all organization repository rulesets”的示例代码

get/orgs/{org}/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/orgs/ORG/rulesets

Response

Status: 200

[
  {
    "id": 21,
    "name": "super cool ruleset",
    "source_type": "Organization",
    "source": "my-org",
    "enforcement": "enabled"
  },
  {
    "id": 432,
    "name": "Another ruleset",
    "source_type": "Organization",
    "source": "my-org",
    "enforcement": "enabled"
  }
]

Create an organization repository ruleset

适用于 GitHub Apps

Create a repository ruleset for an organization.

“Create an organization repository ruleset”的参数

标头

名称, 类型, 说明

accept string

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

路径参数

名称, 类型, 说明

org string 必须

The organization name. The name is not case sensitive.

正文参数

名称, 类型, 说明

name string 必须

The name of the ruleset.

target string

The target of the ruleset.

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

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

Properties of bypass_actors

名称, 类型, 说明
`actor_id` integer The ID of the actor that can bypass a ruleset
`actor_type` string The type of actor that can bypass a ruleset 可以是以下选项之一: `Team`, `Integration`

conditions object

Conditions for a organization ruleset

rules array of objects

An array of rules within the ruleset.

Can be one of these objects:

名称, 类型, 说明

creation object 必须

Parameters to be used for the creation rule

Properties of creation

名称, 类型, 说明
`type` string 必须值: `creation`

update object 必须

Parameters to be used for the update rule

Properties of update

名称, 类型, 说明

type string 必须

值: update

parameters object

Properties of parameters

名称, 类型, 说明
`update_allows_fetch_and_merge` boolean 必须 Branch can pull changes from its upstream repository

deletion object 必须

Parameters to be used for the deletion rule

Properties of deletion

名称, 类型, 说明
`type` string 必须值: `deletion`

required_linear_history object 必须

Parameters to be used for the required_linear_history rule

Properties of required_linear_history

名称, 类型, 说明
`type` string 必须值: `required_linear_history`

required_deployments object 必须

Parameters to be used for the required_deployments rule

Properties of required_deployments

名称, 类型, 说明

type string 必须

值: required_deployments

parameters object

Properties of parameters

名称, 类型, 说明
`required_deployment_environments` array of strings 必须 The environments that must be successfully deployed to before branches can be merged.

required_signatures object 必须

Parameters to be used for the required_signatures rule

Properties of required_signatures

名称, 类型, 说明
`type` string 必须值: `required_signatures`

pull_request object 必须

Parameters to be used for the pull_request rule

Properties of pull_request

名称, 类型, 说明

type string 必须

值: pull_request

parameters object

Properties of parameters

名称, 类型, 说明
`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 必须

Parameters to be used for the required_status_checks rule

Properties of required_status_checks

名称, 类型, 说明

type string 必须

值: required_status_checks

parameters object

Properties of parameters

名称, 类型, 说明

required_status_checks array of objects 必须

Status checks that are required.

Properties of required_status_checks

名称, 类型, 说明
`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 必须

Parameters to be used for the non_fast_forward rule

Properties of non_fast_forward

名称, 类型, 说明
`type` string 必须值: `non_fast_forward`

commit_message_pattern object 必须

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

名称, 类型, 说明

type string 必须

值: commit_message_pattern

parameters object

Properties of parameters

名称, 类型, 说明
`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

Properties of commit_author_email_pattern

名称, 类型, 说明

type string 必须

值: commit_author_email_pattern

parameters object

Properties of parameters

名称, 类型, 说明
`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

Properties of committer_email_pattern

名称, 类型, 说明

type string 必须

值: committer_email_pattern

parameters object

Properties of parameters

名称, 类型, 说明
`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

Properties of branch_name_pattern

名称, 类型, 说明

type string 必须

值: branch_name_pattern

parameters object

Properties of parameters

名称, 类型, 说明
`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

Properties of tag_name_pattern

名称, 类型, 说明

type string 必须

值: tag_name_pattern

parameters object

Properties of parameters

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

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

状态代码	说明
`201`	Created
`404`	Resource not found
`500`	Internal Error

“Create an organization repository ruleset”的示例代码

post/orgs/{org}/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/orgs/ORG/rulesets \
  -d '{"name":"super cool ruleset","target":"branch","enforcement":"active","bypass_actors":[{"actor_id":234,"actor_type":"Team"}],"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": 21,
  "name": "super cool ruleset",
  "target": "branch",
  "source_type": "Organization",
  "source": "my-org",
  "enforcement": "active",
  "bypass_actors": [
    {
      "actor_id": 234,
      "actor_type": "Team"
    }
  ],
  "conditions": {
    "ref_name": {
      "include": [
        "refs/heads/main",
        "refs/heads/master"
      ],
      "exclude": [
        "refs/heads/dev*"
      ]
    },
    "repository_name": {
      "include": [
        "important_repository",
        "another_important_repository"
      ],
      "exclude": [
        "unimportant_repository"
      ],
      "protected": true
    }
  },
  "rules": [
    {
      "type": "commit_author_email_pattern",
      "parameters": {
        "operator": "contains",
        "pattern": "github"
      }
    }
  ]
}

Get an organization repository ruleset

适用于 GitHub Apps

Get a repository ruleset for an organization.

“Get an organization repository ruleset”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`org` string 必须 The organization name. The name is not case sensitive.
`ruleset_id` integer 必须 The ID of the ruleset.

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

状态代码	说明
`200`	OK
`404`	Resource not found
`500`	Internal Error

“Get an organization repository ruleset”的示例代码

get/orgs/{org}/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/orgs/ORG/rulesets/RULESET_ID

Response

Status: 200

{
  "id": 21,
  "name": "super cool ruleset",
  "target": "branch",
  "source_type": "Organization",
  "source": "my-org",
  "enforcement": "active",
  "bypass_actors": [
    {
      "actor_id": 234,
      "actor_type": "Team"
    }
  ],
  "conditions": {
    "ref_name": {
      "include": [
        "refs/heads/main",
        "refs/heads/master"
      ],
      "exclude": [
        "refs/heads/dev*"
      ]
    },
    "repository_name": {
      "include": [
        "important_repository",
        "another_important_repository"
      ],
      "exclude": [
        "unimportant_repository"
      ],
      "protected": true
    }
  },
  "rules": [
    {
      "type": "commit_author_email_pattern",
      "parameters": {
        "operator": "contains",
        "pattern": "github"
      }
    }
  ]
}

Update an organization repository ruleset

适用于 GitHub Apps

Update a ruleset for an organization.

“Update an organization repository ruleset”的参数

标头

名称, 类型, 说明

accept string

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

路径参数

名称, 类型, 说明

org string 必须

The organization name. 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.

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

enforcement string

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

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Properties of bypass_actors

名称, 类型, 说明
`actor_id` integer The ID of the actor that can bypass a ruleset
`actor_type` string The type of actor that can bypass a ruleset 可以是以下选项之一: `Team`, `Integration`

conditions object

Conditions for a organization ruleset

rules array of objects

An array of rules within the ruleset.

Can be one of these objects:

名称, 类型, 说明

creation object 必须

Parameters to be used for the creation rule

Properties of creation

名称, 类型, 说明
`type` string 必须值: `creation`

update object 必须

Parameters to be used for the update rule

Properties of update

名称, 类型, 说明

type string 必须

值: update

parameters object

Properties of parameters

名称, 类型, 说明
`update_allows_fetch_and_merge` boolean 必须 Branch can pull changes from its upstream repository

deletion object 必须

Parameters to be used for the deletion rule

Properties of deletion

名称, 类型, 说明
`type` string 必须值: `deletion`

required_linear_history object 必须

Parameters to be used for the required_linear_history rule

Properties of required_linear_history

名称, 类型, 说明
`type` string 必须值: `required_linear_history`

required_deployments object 必须

Parameters to be used for the required_deployments rule

Properties of required_deployments

名称, 类型, 说明

type string 必须

值: required_deployments

parameters object

Properties of parameters

名称, 类型, 说明
`required_deployment_environments` array of strings 必须 The environments that must be successfully deployed to before branches can be merged.

required_signatures object 必须

Parameters to be used for the required_signatures rule

Properties of required_signatures

名称, 类型, 说明
`type` string 必须值: `required_signatures`

pull_request object 必须

Parameters to be used for the pull_request rule

Properties of pull_request

名称, 类型, 说明

type string 必须

值: pull_request

parameters object

Properties of parameters

名称, 类型, 说明
`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 必须

Parameters to be used for the required_status_checks rule

Properties of required_status_checks

名称, 类型, 说明

type string 必须

值: required_status_checks

parameters object

Properties of parameters

名称, 类型, 说明

required_status_checks array of objects 必须

Status checks that are required.

Properties of required_status_checks

名称, 类型, 说明
`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 必须

Parameters to be used for the non_fast_forward rule

Properties of non_fast_forward

名称, 类型, 说明
`type` string 必须值: `non_fast_forward`

commit_message_pattern object 必须

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

名称, 类型, 说明

type string 必须

值: commit_message_pattern

parameters object

Properties of parameters

名称, 类型, 说明
`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

Properties of commit_author_email_pattern

名称, 类型, 说明

type string 必须

值: commit_author_email_pattern

parameters object

Properties of parameters

名称, 类型, 说明
`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

Properties of committer_email_pattern

名称, 类型, 说明

type string 必须

值: committer_email_pattern

parameters object

Properties of parameters

名称, 类型, 说明
`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

Properties of branch_name_pattern

名称, 类型, 说明

type string 必须

值: branch_name_pattern

parameters object

Properties of parameters

名称, 类型, 说明
`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

Properties of tag_name_pattern

名称, 类型, 说明

type string 必须

值: tag_name_pattern

parameters object

Properties of parameters

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

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

状态代码	说明
`200`	OK
`404`	Resource not found
`500`	Internal Error

“Update an organization repository ruleset”的示例代码

put/orgs/{org}/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/orgs/ORG/rulesets/RULESET_ID \
  -d '{"name":"super cool ruleset","target":"branch","enforcement":"active","bypass_actors":[{"actor_id":234,"actor_type":"Team"}],"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": 21,
  "name": "super cool ruleset",
  "target": "branch",
  "source_type": "Organization",
  "source": "my-org",
  "enforcement": "active",
  "bypass_actors": [
    {
      "actor_id": 234,
      "actor_type": "Team"
    }
  ],
  "conditions": {
    "ref_name": {
      "include": [
        "refs/heads/main",
        "refs/heads/master"
      ],
      "exclude": [
        "refs/heads/dev*"
      ]
    },
    "repository_name": {
      "include": [
        "important_repository",
        "another_important_repository"
      ],
      "exclude": [
        "unimportant_repository"
      ],
      "protected": true
    }
  },
  "rules": [
    {
      "type": "commit_author_email_pattern",
      "parameters": {
        "operator": "contains",
        "pattern": "github"
      }
    }
  ]
}

Delete an organization repository ruleset

适用于 GitHub Apps

Delete a ruleset for an organization.

“Delete an organization repository ruleset”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`org` string 必须 The organization name. The name is not case sensitive.
`ruleset_id` integer 必须 The ID of the ruleset.

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

状态代码	说明
`204`	No Content
`404`	Resource not found
`500`	Internal Error

“Delete an organization repository ruleset”的示例代码

delete/orgs/{org}/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/orgs/ORG/rulesets/RULESET_ID

Response

Status: 204