ルール - GitHub Docs

Get rules for a branch

Returns all rules that apply to the specified branch.

"Get rules for a branch" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.
パスパラメーター
名前, Type, 説明
`owner` string 必須 The account owner of the repository. The name is not case sensitive.
`repo` string 必須 The name of the repository. 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.

"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",
    "parameters": {
      "operator": "starts_with",
      "pattern": "issue"
    }
  },
  {
    "type": "commit_author_email_pattern",
    "parameters": {
      "operator": "contains",
      "pattern": "github"
    }
  }
]

Get all repository rulesets

に対応 GitHub Apps

Get all the rulesets for a repository.

"Get all repository rulesets" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.
パスパラメーター
名前, Type, 説明
`owner` string 必須 The account owner of the repository. The name is not case sensitive.
`repo` string 必須 The name of the repository. The name is not case sensitive.
クエリパラメーター
名前, Type, 説明
`includes_parents` boolean Include rulesets configured at higher levels that apply to this repository

"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"
  },
  {
    "id": 314,
    "name": "Another ruleset",
    "source_type": "Repository",
    "source": "monalisa/my-repo",
    "enforcement": "enabled"
  }
]

Create a repository ruleset

に対応 GitHub Apps

Create a ruleset for a repository.

"Create a repository ruleset" のパラメーター

ヘッダー

名前, Type, 説明

accept string

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

パスパラメーター

名前, Type, 説明

owner string 必須

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

repo string 必須

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

本文のパラメーター

名前, Type, 説明

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_mode string

The permission level required to bypass this ruleset. "repository" allows those with bypass permission at the repository level to bypass. "organization" allows those with bypass permission at the organization level to bypass. "none" prevents anyone from bypassing.

次のいずれかにできます: none, repository, organization

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Properties of bypass_actors

名前, Type, 説明
`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

Parameters for a repository ruleset ref name condition

Properties of conditions

名前, Type, 説明

ref_name object

Properties of ref_name

名前, Type, 説明
`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.

Can be one of these objects:

名前, Type, 説明

creation object 必須

Parameters to be used for the creation rule

Properties of creation

名前, Type, 説明
`type` string 必須値: `creation`

update object 必須

Parameters to be used for the update rule

Properties of update

名前, Type, 説明

type string 必須

値: update

parameters object

Properties of parameters

名前, Type, 説明
`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, 説明
`type` string 必須値: `deletion`

required_linear_history object 必須

Parameters to be used for the required_linear_history rule

Properties of required_linear_history

名前, Type, 説明
`type` string 必須値: `required_linear_history`

required_deployments object 必須

Parameters to be used for the required_deployments rule

Properties of required_deployments

名前, Type, 説明

type string 必須

値: required_deployments

parameters object

Properties of parameters

名前, Type, 説明
`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, 説明
`type` string 必須値: `required_signatures`

pull_request object 必須

Parameters to be used for the pull_request rule

Properties of pull_request

名前, Type, 説明

type string 必須

値: pull_request

parameters object

Properties of parameters

名前, Type, 説明
`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, 説明

type string 必須

値: required_status_checks

parameters object

Properties of parameters

名前, Type, 説明

required_status_checks array of objects 必須

Status checks that are required.

Properties of required_status_checks

名前, Type, 説明
`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, 説明
`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, 説明

type string 必須

値: commit_message_pattern

parameters object

Properties of parameters

名前, Type, 説明
`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, 説明

type string 必須

値: commit_author_email_pattern

parameters object

Properties of parameters

名前, Type, 説明
`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, 説明

type string 必須

値: committer_email_pattern

parameters object

Properties of parameters

名前, Type, 説明
`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, 説明

type string 必須

値: branch_name_pattern

parameters object

Properties of parameters

名前, Type, 説明
`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, 説明

type string 必須

値: tag_name_pattern

parameters object

Properties of parameters

名前, Type, 説明
`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 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_mode":"repository","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": 42,
  "name": "super cool ruleset",
  "target": "branch",
  "source_type": "Repository",
  "source": "monalisa/my-repo",
  "enforcement": "active",
  "bypass_mode": "repository",
  "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"
      }
    }
  ]
}

Get a repository ruleset

に対応 GitHub Apps

Get a ruleset for a repository.

"Get a repository ruleset" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.
パスパラメーター
名前, Type, 説明
`owner` string 必須 The account owner of the repository. The name is not case sensitive.
`repo` string 必須 The name of the repository. The name is not case sensitive.
`ruleset_id` integer 必須 The ID of the ruleset.
クエリパラメーター
名前, Type, 説明
`includes_parents` boolean Include rulesets configured at higher levels that apply to this repository

"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_mode": "repository",
  "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"
      }
    }
  ]
}

Update a repository ruleset

に対応 GitHub Apps

Update a ruleset for a repository.

"Update a repository ruleset" のパラメーター

ヘッダー

名前, Type, 説明

accept string

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

パスパラメーター

名前, Type, 説明

owner string 必須

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

repo string 必須

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

ruleset_id integer 必須

The ID of the ruleset.

本文のパラメーター

名前, Type, 説明

name string

The name of the ruleset.

target string

The target of the ruleset.

次のいずれかにできます: branch, tag

enforcement string

次のいずれかにできます: disabled, active, evaluate

bypass_mode string

次のいずれかにできます: none, repository, organization

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Properties of bypass_actors

名前, Type, 説明
`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

Parameters for a repository ruleset ref name condition

Properties of conditions

名前, Type, 説明

ref_name object

Properties of ref_name

名前, Type, 説明
`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.

Can be one of these objects:

名前, Type, 説明

creation object 必須

Parameters to be used for the creation rule

Properties of creation

名前, Type, 説明
`type` string 必須値: `creation`

update object 必須

Parameters to be used for the update rule

Properties of update

名前, Type, 説明

type string 必須

値: update

parameters object

Properties of parameters

名前, Type, 説明
`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, 説明
`type` string 必須値: `deletion`

required_linear_history object 必須

Parameters to be used for the required_linear_history rule

Properties of required_linear_history

名前, Type, 説明
`type` string 必須値: `required_linear_history`

required_deployments object 必須

Parameters to be used for the required_deployments rule

Properties of required_deployments

名前, Type, 説明

type string 必須

値: required_deployments

parameters object

Properties of parameters

名前, Type, 説明
`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, 説明
`type` string 必須値: `required_signatures`

pull_request object 必須

Parameters to be used for the pull_request rule

Properties of pull_request

名前, Type, 説明

type string 必須

値: pull_request

parameters object

Properties of parameters

名前, Type, 説明
`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, 説明

type string 必須

値: required_status_checks

parameters object

Properties of parameters

名前, Type, 説明

required_status_checks array of objects 必須

Status checks that are required.

Properties of required_status_checks

名前, Type, 説明
`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, 説明
`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, 説明

type string 必須

値: commit_message_pattern

parameters object

Properties of parameters

名前, Type, 説明
`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, 説明

type string 必須

値: commit_author_email_pattern

parameters object

Properties of parameters

名前, Type, 説明
`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, 説明

type string 必須

値: committer_email_pattern

parameters object

Properties of parameters

名前, Type, 説明
`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, 説明

type string 必須

値: branch_name_pattern

parameters object

Properties of parameters

名前, Type, 説明
`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, 説明

type string 必須

値: tag_name_pattern

parameters object

Properties of parameters

名前, Type, 説明
`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 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_mode":"repository","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": 42,
  "name": "super cool ruleset",
  "target": "branch",
  "source_type": "Repository",
  "source": "monalisa/my-repo",
  "enforcement": "active",
  "bypass_mode": "repository",
  "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"
      }
    }
  ]
}

Delete a repository ruleset

に対応 GitHub Apps

Delete a ruleset for a repository.

"Delete a repository ruleset" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.
パスパラメーター
名前, Type, 説明
`owner` string 必須 The account owner of the repository. The name is not case sensitive.
`repo` string 必須 The name of the repository. 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