规则
使用 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.
Parameters for "Get rules for a branch"
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
owner string 必须The account owner of the repository. The name is not case sensitive. |
repo string 必须The name of the repository without the |
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). 默认: |
page integer Page number of the results to fetch. 默认: |
HTTP response status codes for "Get rules for a branch"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get rules for a 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.
Parameters for "Get all repository rulesets"
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
owner string 必须The account owner of the repository. The name is not case sensitive. |
repo string 必须The name of the repository without the |
名称, 类型, 说明 |
---|
per_page integer The number of results per page (max 100). 默认: |
page integer Page number of the results to fetch. 默认: |
includes_parents boolean Include rulesets configured at higher levels that apply to this repository 默认: |
HTTP response status codes for "Get all repository rulesets"
Status code | Description |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
Code samples for "Get all repository 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.
Parameters for "Create a repository ruleset"
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
owner string 必须The account owner of the repository. The name is not case sensitive. |
repo string 必须The name of the repository without the |
名称, 类型, 说明 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name string 必须The name of the ruleset. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target string The target of the ruleset. 可以是以下选项之一: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enforcement string 必须The enforcement level of the ruleset. 可以是以下选项之一: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bypass_actors array of objects The actors that can bypass the rules in this ruleset | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties of |
名称, 类型, 说明 |
---|
actor_id integer 必须The ID of the actor that can bypass a ruleset. If |
actor_type string 必须The type of actor that can bypass a ruleset 可以是以下选项之一: |
bypass_mode string 必须When the specified actor can bypass the ruleset. 可以是以下选项之一: |
conditions
object Parameters for a repository ruleset ref name condition
Properties of conditions
名称, 类型, 说明 | |||
---|---|---|---|
ref_name object | |||
Properties of |
名称, 类型, 说明 |
---|
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 |
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:
名称, 类型, 说明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
creation object 必须Only allow users with bypass permission to create matching refs. | ||||||||||||
Properties of |
名称, 类型, 说明 |
---|
type string 必须值: |
update
object 必须Only allow users with bypass permission to update matching refs.
Properties of update
名称, 类型, 说明 | ||
---|---|---|
type string 必须值: | ||
parameters object | ||
Properties of |
名称, 类型, 说明 |
---|
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.
Properties of deletion
名称, 类型, 说明 |
---|
type string 必须值: |
required_linear_history
object 必须Prevent merge commits from being pushed to matching refs.
Properties of required_linear_history
名称, 类型, 说明 |
---|
type string 必须值: |
required_deployments
object 必须Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
Properties of required_deployments
名称, 类型, 说明 | ||
---|---|---|
type string 必须值: | ||
parameters object | ||
Properties of |
名称, 类型, 说明 |
---|
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.
Properties of required_signatures
名称, 类型, 说明 |
---|
type string 必须值: |
pull_request
object 必须Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Properties of pull_request
名称, 类型, 说明 | ||||||
---|---|---|---|---|---|---|
type string 必须值: | ||||||
parameters object | ||||||
Properties of |
名称, 类型, 说明 |
---|
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.
Properties of required_status_checks
名称, 类型, 说明 | |||||||
---|---|---|---|---|---|---|---|
type string 必须值: | |||||||
parameters object | |||||||
Properties of |
名称, 类型, 说明 | |||
---|---|---|---|
required_status_checks array of objects 必须Status checks that are required. | |||
Properties of |
名称, 类型, 说明 |
---|
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.
Properties of non_fast_forward
名称, 类型, 说明 |
---|
type string 必须值: |
commit_message_pattern
object 必须Parameters to be used for the commit_message_pattern rule
Properties of commit_message_pattern
名称, 类型, 说明 | |||||
---|---|---|---|---|---|
type string 必须值: | |||||
parameters object | |||||
Properties of |
名称, 类型, 说明 |
---|
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. |
commit_author_email_pattern
object 必须Parameters to be used for the commit_author_email_pattern rule
名称, 类型, 说明 | |||||
---|---|---|---|---|---|
type string 必须值: | |||||
parameters object | |||||
Properties of |
名称, 类型, 说明 |
---|
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. |
committer_email_pattern
object 必须Parameters to be used for the committer_email_pattern rule
Properties of committer_email_pattern
名称, 类型, 说明 | |||||
---|---|---|---|---|---|
type string 必须值: | |||||
parameters object | |||||
Properties of |
名称, 类型, 说明 |
---|
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. |
branch_name_pattern
object 必须Parameters to be used for the branch_name_pattern rule
Properties of branch_name_pattern
名称, 类型, 说明 | |||||
---|---|---|---|---|---|
type string 必须值: | |||||
parameters object | |||||
Properties of |
名称, 类型, 说明 |
---|
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. |
tag_name_pattern
object 必须Parameters to be used for the tag_name_pattern rule
Properties of tag_name_pattern
名称, 类型, 说明 | |||||
---|---|---|---|---|---|
type string 必须值: | |||||
parameters object | |||||
Properties of |
名称, 类型, 说明 |
---|
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. |
workflows
object 必须Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
Properties of workflows
名称, 类型, 说明 | ||||||||
---|---|---|---|---|---|---|---|---|
type string 必须值: | ||||||||
parameters object | ||||||||
Properties of |
名称, 类型, 说明 | |||||
---|---|---|---|---|---|
workflows array of objects 必须Workflows that must pass for this rule to pass. | |||||
Properties of |
名称, 类型, 说明 |
---|
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 |
HTTP response status codes for "Create a repository ruleset"
Status code | Description |
---|---|
201 | Created |
404 | Resource not found |
500 | Internal Error |
Code samples for "Create a repository ruleset"
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.
Parameters for "Get a repository ruleset"
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
owner string 必须The account owner of the repository. The name is not case sensitive. |
repo string 必须The name of the repository without the |
ruleset_id integer 必须The ID of the ruleset. |
名称, 类型, 说明 |
---|
includes_parents boolean Include rulesets configured at higher levels that apply to this repository 默认: |
HTTP response status codes for "Get a repository ruleset"
Status code | Description |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
Code samples for "Get a repository ruleset"
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.
Parameters for "Update a repository ruleset"
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
owner string 必须The account owner of the repository. The name is not case sensitive. |
repo string 必须The name of the repository without the |
ruleset_id integer 必须The ID of the ruleset. |
名称, 类型, 说明 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name string The name of the ruleset. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target string The target of the ruleset. 可以是以下选项之一: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enforcement string The enforcement level of the ruleset. 可以是以下选项之一: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bypass_actors array of objects The actors that can bypass the rules in this ruleset | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties of |
名称, 类型, 说明 |
---|
actor_id integer 必须The ID of the actor that can bypass a ruleset. If |
actor_type string 必须The type of actor that can bypass a ruleset 可以是以下选项之一: |
bypass_mode string 必须When the specified actor can bypass the ruleset. 可以是以下选项之一: |
conditions
object Parameters for a repository ruleset ref name condition
Properties of conditions
名称, 类型, 说明 | |||
---|---|---|---|
ref_name object | |||
Properties of |
名称, 类型, 说明 |
---|
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 |
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:
名称, 类型, 说明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
creation object 必须Only allow users with bypass permission to create matching refs. | ||||||||||||
Properties of |
名称, 类型, 说明 |
---|
type string 必须值: |
update
object 必须Only allow users with bypass permission to update matching refs.
Properties of update
名称, 类型, 说明 | ||
---|---|---|
type string 必须值: | ||
parameters object | ||
Properties of |
名称, 类型, 说明 |
---|
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.
Properties of deletion
名称, 类型, 说明 |
---|
type string 必须值: |
required_linear_history
object 必须Prevent merge commits from being pushed to matching refs.
Properties of required_linear_history
名称, 类型, 说明 |
---|
type string 必须值: |
required_deployments
object 必须Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
Properties of required_deployments
名称, 类型, 说明 | ||
---|---|---|
type string 必须值: | ||
parameters object | ||
Properties of |
名称, 类型, 说明 |
---|
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.
Properties of required_signatures
名称, 类型, 说明 |
---|
type string 必须值: |
pull_request
object 必须Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Properties of pull_request
名称, 类型, 说明 | ||||||
---|---|---|---|---|---|---|
type string 必须值: | ||||||
parameters object | ||||||
Properties of |
名称, 类型, 说明 |
---|
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.
Properties of required_status_checks
名称, 类型, 说明 | |||||||
---|---|---|---|---|---|---|---|
type string 必须值: | |||||||
parameters object | |||||||
Properties of |
名称, 类型, 说明 | |||
---|---|---|---|
required_status_checks array of objects 必须Status checks that are required. | |||
Properties of |
名称, 类型, 说明 |
---|
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.
Properties of non_fast_forward
名称, 类型, 说明 |
---|
type string 必须值: |
commit_message_pattern
object 必须Parameters to be used for the commit_message_pattern rule
Properties of commit_message_pattern
名称, 类型, 说明 | |||||
---|---|---|---|---|---|
type string 必须值: | |||||
parameters object | |||||
Properties of |
名称, 类型, 说明 |
---|
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. |
commit_author_email_pattern
object 必须Parameters to be used for the commit_author_email_pattern rule
名称, 类型, 说明 | |||||
---|---|---|---|---|---|
type string 必须值: | |||||
parameters object | |||||
Properties of |
名称, 类型, 说明 |
---|
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. |
committer_email_pattern
object 必须Parameters to be used for the committer_email_pattern rule
Properties of committer_email_pattern
名称, 类型, 说明 | |||||
---|---|---|---|---|---|
type string 必须值: | |||||
parameters object | |||||
Properties of |
名称, 类型, 说明 |
---|
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. |
branch_name_pattern
object 必须Parameters to be used for the branch_name_pattern rule
Properties of branch_name_pattern
名称, 类型, 说明 | |||||
---|---|---|---|---|---|
type string 必须值: | |||||
parameters object | |||||
Properties of |
名称, 类型, 说明 |
---|
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. |
tag_name_pattern
object 必须Parameters to be used for the tag_name_pattern rule
Properties of tag_name_pattern
名称, 类型, 说明 | |||||
---|---|---|---|---|---|
type string 必须值: | |||||
parameters object | |||||
Properties of |
名称, 类型, 说明 |
---|
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. |
workflows
object 必须Require all changes made to a targeted branch to pass the specified workflows before they can be merged.
Properties of workflows
名称, 类型, 说明 | ||||||||
---|---|---|---|---|---|---|---|---|
type string 必须值: | ||||||||
parameters object | ||||||||
Properties of |
名称, 类型, 说明 | |||||
---|---|---|---|---|---|
workflows array of objects 必须Workflows that must pass for this rule to pass. | |||||
Properties of |
名称, 类型, 说明 |
---|
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 |
HTTP response status codes for "Update a repository ruleset"
Status code | Description |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
Code samples for "Update a repository ruleset"
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.
Parameters for "Delete a repository ruleset"
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
owner string 必须The account owner of the repository. The name is not case sensitive. |
repo string 必须The name of the repository without the |
ruleset_id integer 必须The ID of the ruleset. |
HTTP response status codes for "Delete a repository ruleset"
Status code | Description |
---|---|
204 | No Content |
404 | Resource not found |
500 | Internal Error |
Code samples for "Delete a repository ruleset"
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