규칙에 대한 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 |
속성, 형식, 설명 |
---|
owner string RequiredThe account owner of the repository. The name is not case sensitive. |
repo string RequiredThe name of the repository without the |
branch string RequiredThe 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." 기본값: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 기본값: |
"Get rules for a branch"에 대한 HTTP 응답 상태 코드
상태 코드 | 설명 |
---|---|
200 | OK |
"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" \
http(s)://HOSTNAME/api/v3/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 |
속성, 형식, 설명 |
---|
owner string RequiredThe account owner of the repository. The name is not case sensitive. |
repo string RequiredThe name of the repository without the |
속성, 형식, 설명 |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 기본값: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 기본값: |
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"에 대한 코드 샘플
요청 예제
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/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://HOSTNAME/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://HOSTNAME/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 |
속성, 형식, 설명 |
---|
owner string RequiredThe account owner of the repository. The name is not case sensitive. |
repo string RequiredThe name of the repository without the |
속성, 형식, 설명 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name string RequiredThe name of the ruleset. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target string The target of the ruleset. 기본값: 다음 중 하나일 수 있습니다.: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enforcement string RequiredThe 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 RequiredThe ID of the actor that can bypass a ruleset. If |
actor_type string RequiredThe type of actor that can bypass a ruleset 다음 중 하나일 수 있습니다.: |
bypass_mode string RequiredWhen 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 RequiredOnly allow users with bypass permission to create matching refs. | |||||||||||||
Properties of |
속성, 형식, 설명 |
---|
type string Required값: |
update
object RequiredOnly allow users with bypass permission to update matching refs.
Properties of update
속성, 형식, 설명 | ||
---|---|---|
type string Required값: | ||
parameters object | ||
Properties of |
속성, 형식, 설명 |
---|
update_allows_fetch_and_merge boolean RequiredBranch can pull changes from its upstream repository |
deletion
object RequiredOnly allow users with bypass permissions to delete matching refs.
Properties of deletion
속성, 형식, 설명 |
---|
type string Required값: |
required_linear_history
object RequiredPrevent merge commits from being pushed to matching refs.
Properties of required_linear_history
속성, 형식, 설명 |
---|
type string Required값: |
required_deployments
object RequiredChoose 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 Required값: | ||
parameters object | ||
Properties of |
속성, 형식, 설명 |
---|
required_deployment_environments array of strings RequiredThe environments that must be successfully deployed to before branches can be merged. |
required_signatures
object RequiredCommits pushed to matching refs must have verified signatures.
Properties of required_signatures
속성, 형식, 설명 |
---|
type string Required값: |
pull_request
object RequiredRequire 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 Required값: | ||||||
parameters object | ||||||
Properties of |
속성, 형식, 설명 |
---|
dismiss_stale_reviews_on_push boolean RequiredNew, reviewable commits pushed will dismiss previous pull request review approvals. |
require_code_owner_review boolean RequiredRequire an approving review in pull requests that modify files that have a designated code owner. |
require_last_push_approval boolean RequiredWhether the most recent reviewable push must be approved by someone other than the person who pushed it. |
required_approving_review_count integer RequiredThe number of approving reviews that are required before a pull request can be merged. |
required_review_thread_resolution boolean RequiredAll conversations on code must be resolved before a pull request can be merged. |
required_status_checks
object RequiredChoose 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 Required값: | ||||||||
parameters object | ||||||||
Properties of |
속성, 형식, 설명 | |||
---|---|---|---|
do_not_enforce_on_create boolean Allow repositories and branches to be created if a check would otherwise prohibit it. | |||
required_status_checks array of objects RequiredStatus checks that are required. | |||
Properties of |
속성, 형식, 설명 |
---|
context string RequiredThe 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 RequiredWhether 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 RequiredPrevent users with push access from force pushing to refs.
Properties of non_fast_forward
속성, 형식, 설명 |
---|
type string Required값: |
commit_message_pattern
object RequiredParameters to be used for the commit_message_pattern rule
Properties of commit_message_pattern
속성, 형식, 설명 | |||||
---|---|---|---|---|---|
type string Required값: | |||||
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 RequiredThe operator to use for matching. 다음 중 하나일 수 있습니다.: |
pattern string RequiredThe pattern to match with. |
commit_author_email_pattern
object RequiredParameters to be used for the commit_author_email_pattern rule
속성, 형식, 설명 | |||||
---|---|---|---|---|---|
type string Required값: | |||||
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 RequiredThe operator to use for matching. 다음 중 하나일 수 있습니다.: |
pattern string RequiredThe pattern to match with. |
committer_email_pattern
object RequiredParameters to be used for the committer_email_pattern rule
Properties of committer_email_pattern
속성, 형식, 설명 | |||||
---|---|---|---|---|---|
type string Required값: | |||||
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 RequiredThe operator to use for matching. 다음 중 하나일 수 있습니다.: |
pattern string RequiredThe pattern to match with. |
branch_name_pattern
object RequiredParameters to be used for the branch_name_pattern rule
Properties of branch_name_pattern
속성, 형식, 설명 | |||||
---|---|---|---|---|---|
type string Required값: | |||||
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 RequiredThe operator to use for matching. 다음 중 하나일 수 있습니다.: |
pattern string RequiredThe pattern to match with. |
tag_name_pattern
object RequiredParameters to be used for the tag_name_pattern rule
Properties of tag_name_pattern
속성, 형식, 설명 | |||||
---|---|---|---|---|---|
type string Required값: | |||||
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 RequiredThe operator to use for matching. 다음 중 하나일 수 있습니다.: |
pattern string RequiredThe pattern to match with. |
workflows
object RequiredRequire all changes made to a targeted branch to pass the specified workflows before they can be merged.
Properties of workflows
속성, 형식, 설명 | |||||||||
---|---|---|---|---|---|---|---|---|---|
type string Required값: | |||||||||
parameters object | |||||||||
Properties of |
속성, 형식, 설명 | |||||
---|---|---|---|---|---|
do_not_enforce_on_create boolean Allow repositories and branches to be created if a check would otherwise prohibit it. | |||||
workflows array of objects RequiredWorkflows that must pass for this rule to pass. | |||||
Properties of |
속성, 형식, 설명 |
---|
path string RequiredThe path to the workflow file |
ref string The ref (branch or tag) of the workflow file to use |
repository_id integer RequiredThe ID of the repository where the workflow is defined |
sha string The commit SHA of the workflow file to use |
"Create a repository ruleset"에 대한 HTTP 응답 상태 코드
상태 코드 | 설명 |
---|---|
201 | Created |
404 | Resource not found |
500 | Internal Error |
"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" \
http(s)://HOSTNAME/api/v3/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://HOSTNAME/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.
Note: To prevent leaking sensitive information, the bypass_actors
property is only returned if the user
making the API request has write access to the ruleset.
"Get a repository ruleset"에 대한 세분화된 액세스 토큰
이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:
세분화된 토큰에는 다음 권한 집합이 있어야 합니다.:
- "Metadata" repository permissions (read)
공용 리소스만 요청되는 경우 인증 또는 앞서 언급한 권한 없이 이 엔드포인트를 사용할 수 있습니다.
"Get a repository ruleset"에 대한 매개 변수
속성, 형식, 설명 |
---|
accept string Setting to |
속성, 형식, 설명 |
---|
owner string RequiredThe account owner of the repository. The name is not case sensitive. |
repo string RequiredThe name of the repository without the |
ruleset_id integer RequiredThe ID of the ruleset. |
속성, 형식, 설명 |
---|
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"에 대한 코드 샘플
요청 예제
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/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://HOSTNAME/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 |
속성, 형식, 설명 |
---|
owner string RequiredThe account owner of the repository. The name is not case sensitive. |
repo string RequiredThe name of the repository without the |
ruleset_id integer RequiredThe 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 RequiredThe ID of the actor that can bypass a ruleset. If |
actor_type string RequiredThe type of actor that can bypass a ruleset 다음 중 하나일 수 있습니다.: |
bypass_mode string RequiredWhen 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 RequiredOnly allow users with bypass permission to create matching refs. | |||||||||||||
Properties of |
속성, 형식, 설명 |
---|
type string Required값: |
update
object RequiredOnly allow users with bypass permission to update matching refs.
Properties of update
속성, 형식, 설명 | ||
---|---|---|
type string Required값: | ||
parameters object | ||
Properties of |
속성, 형식, 설명 |
---|
update_allows_fetch_and_merge boolean RequiredBranch can pull changes from its upstream repository |
deletion
object RequiredOnly allow users with bypass permissions to delete matching refs.
Properties of deletion
속성, 형식, 설명 |
---|
type string Required값: |
required_linear_history
object RequiredPrevent merge commits from being pushed to matching refs.
Properties of required_linear_history
속성, 형식, 설명 |
---|
type string Required값: |
required_deployments
object RequiredChoose 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 Required값: | ||
parameters object | ||
Properties of |
속성, 형식, 설명 |
---|
required_deployment_environments array of strings RequiredThe environments that must be successfully deployed to before branches can be merged. |
required_signatures
object RequiredCommits pushed to matching refs must have verified signatures.
Properties of required_signatures
속성, 형식, 설명 |
---|
type string Required값: |
pull_request
object RequiredRequire 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 Required값: | ||||||
parameters object | ||||||
Properties of |
속성, 형식, 설명 |
---|
dismiss_stale_reviews_on_push boolean RequiredNew, reviewable commits pushed will dismiss previous pull request review approvals. |
require_code_owner_review boolean RequiredRequire an approving review in pull requests that modify files that have a designated code owner. |
require_last_push_approval boolean RequiredWhether the most recent reviewable push must be approved by someone other than the person who pushed it. |
required_approving_review_count integer RequiredThe number of approving reviews that are required before a pull request can be merged. |
required_review_thread_resolution boolean RequiredAll conversations on code must be resolved before a pull request can be merged. |
required_status_checks
object RequiredChoose 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 Required값: | ||||||||
parameters object | ||||||||
Properties of |
속성, 형식, 설명 | |||
---|---|---|---|
do_not_enforce_on_create boolean Allow repositories and branches to be created if a check would otherwise prohibit it. | |||
required_status_checks array of objects RequiredStatus checks that are required. | |||
Properties of |
속성, 형식, 설명 |
---|
context string RequiredThe 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 RequiredWhether 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 RequiredPrevent users with push access from force pushing to refs.
Properties of non_fast_forward
속성, 형식, 설명 |
---|
type string Required값: |
commit_message_pattern
object RequiredParameters to be used for the commit_message_pattern rule
Properties of commit_message_pattern
속성, 형식, 설명 | |||||
---|---|---|---|---|---|
type string Required값: | |||||
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 RequiredThe operator to use for matching. 다음 중 하나일 수 있습니다.: |
pattern string RequiredThe pattern to match with. |
commit_author_email_pattern
object RequiredParameters to be used for the commit_author_email_pattern rule
속성, 형식, 설명 | |||||
---|---|---|---|---|---|
type string Required값: | |||||
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 RequiredThe operator to use for matching. 다음 중 하나일 수 있습니다.: |
pattern string RequiredThe pattern to match with. |
committer_email_pattern
object RequiredParameters to be used for the committer_email_pattern rule
Properties of committer_email_pattern
속성, 형식, 설명 | |||||
---|---|---|---|---|---|
type string Required값: | |||||
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 RequiredThe operator to use for matching. 다음 중 하나일 수 있습니다.: |
pattern string RequiredThe pattern to match with. |
branch_name_pattern
object RequiredParameters to be used for the branch_name_pattern rule
Properties of branch_name_pattern
속성, 형식, 설명 | |||||
---|---|---|---|---|---|
type string Required값: | |||||
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 RequiredThe operator to use for matching. 다음 중 하나일 수 있습니다.: |
pattern string RequiredThe pattern to match with. |
tag_name_pattern
object RequiredParameters to be used for the tag_name_pattern rule
Properties of tag_name_pattern
속성, 형식, 설명 | |||||
---|---|---|---|---|---|
type string Required값: | |||||
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 RequiredThe operator to use for matching. 다음 중 하나일 수 있습니다.: |
pattern string RequiredThe pattern to match with. |
workflows
object RequiredRequire all changes made to a targeted branch to pass the specified workflows before they can be merged.
Properties of workflows
속성, 형식, 설명 | |||||||||
---|---|---|---|---|---|---|---|---|---|
type string Required값: | |||||||||
parameters object | |||||||||
Properties of |
속성, 형식, 설명 | |||||
---|---|---|---|---|---|
do_not_enforce_on_create boolean Allow repositories and branches to be created if a check would otherwise prohibit it. | |||||
workflows array of objects RequiredWorkflows that must pass for this rule to pass. | |||||
Properties of |
속성, 형식, 설명 |
---|
path string RequiredThe path to the workflow file |
ref string The ref (branch or tag) of the workflow file to use |
repository_id integer RequiredThe ID of the repository where the workflow is defined |
sha string The commit SHA of the workflow file to use |
"Update a repository ruleset"에 대한 HTTP 응답 상태 코드
상태 코드 | 설명 |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
"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" \
http(s)://HOSTNAME/api/v3/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://HOSTNAME/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 |
속성, 형식, 설명 |
---|
owner string RequiredThe account owner of the repository. The name is not case sensitive. |
repo string RequiredThe name of the repository without the |
ruleset_id integer RequiredThe ID of the ruleset. |
"Delete a repository ruleset"에 대한 HTTP 응답 상태 코드
상태 코드 | 설명 |
---|---|
204 | No Content |
404 | Resource not found |
500 | Internal Error |
"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" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/rulesets/RULESET_ID
Response
Status: 204