Pontos de extremidade da API REST para regras
Use a API REST para gerenciar conjuntos de regras para organizações. Os conjuntos de regras da organização controlam como as pessoas podem interagir com tags e branches selecionados nos repositórios de uma organização.
Get all organization repository rulesets
Get all the repository rulesets for an organization.
Tokens de acesso refinados para "Get all organization repository rulesets"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
- Tokens de acesso de usuário do aplicativo GitHub
- Tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinado deve ter os seguintes conjuntos de permissões:
- "Administration" organization permissions (write)
Parâmetros para "Get all organization repository rulesets"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
Nome, Tipo, Descrição |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: |
targets string A comma-separated list of rule targets to filter by.
If provided, only rulesets that apply to the specified targets will be returned.
For example, |
Códigos de status de resposta HTTP para "Get all organization repository rulesets"
Código de status | Descrição |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
Exemplos de código para "Get all organization repository rulesets"
Exemplo de solicitação
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",
"node_id": "RRS_lACkVXNlcgQB",
"_links": {
"self": {
"href": "https://api.github.com/orgs/my-org/rulesets/21"
},
"html": {
"href": "https://github.com/organizations/my-org/settings/rules/21"
}
},
"created_at": "2023-07-15T08:43:03Z",
"updated_at": "2023-08-23T16:29:47Z"
},
{
"id": 432,
"name": "Another ruleset",
"source_type": "Organization",
"source": "my-org",
"enforcement": "enabled",
"node_id": "RRS_lACkVXNlcgQQ",
"_links": {
"self": {
"href": "https://api.github.com/orgs/my-org/rulesets/432"
},
"html": {
"href": "https://github.com/organizations/my-org/settings/rules/432"
}
},
"created_at": "2023-08-15T08:43:03Z",
"updated_at": "2023-09-23T16:29:47Z"
}
]
Create an organization repository ruleset
Create a repository ruleset for an organization.
Tokens de acesso refinados para "Create an organization repository ruleset"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
- Tokens de acesso de usuário do aplicativo GitHub
- Tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinado deve ter os seguintes conjuntos de permissões:
- "Administration" organization permissions (write)
Parâmetros para "Create an organization repository ruleset"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
Nome, Tipo, Descrição | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name string ObrigatórioThe name of the ruleset. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target string The target of the ruleset Padrão: Pode ser um dos: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enforcement string ObrigatórioThe enforcement level of the ruleset. Pode ser um dos: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bypass_actors array of objects The actors that can bypass the rules in this ruleset | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties of |
Nome, Tipo, Descrição |
---|
actor_id integer or null The ID of the actor that can bypass a ruleset. If |
actor_type string ObrigatórioThe type of actor that can bypass a ruleset Pode ser um dos: |
bypass_mode string When the specified actor can bypass the ruleset. Padrão: Pode ser um dos: |
conditions
object Conditions for an organization ruleset.
The branch and tag rulesets conditions object should contain both repository_name
and ref_name
properties, or both repository_id
and ref_name
properties, or both repository_property
and ref_name
properties.
The push rulesets conditions object does not require the ref_name
property.
Can be one of these objects:
Nome, Tipo, Descrição | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
repository_name_and_ref_name object ObrigatórioConditions to target repositories by name and refs by name | |||||||||||||||||||||
Properties of |
Nome, Tipo, Descrição | ||||
---|---|---|---|---|
ref_name object | ||||
Properties of |
Nome, Tipo, Descrição |
---|
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. |
repository_name
object ObrigatórioProperties of repository_name
Nome, Tipo, Descrição |
---|
include array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts |
exclude array of strings Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. |
protected boolean Whether renaming of target repositories is prevented. |
repository_id_and_ref_name
object ObrigatórioConditions to target repositories by id and refs by name
Properties of repository_id_and_ref_name
Nome, Tipo, Descrição | |||
---|---|---|---|
ref_name object | |||
Properties of |
Nome, Tipo, Descrição |
---|
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. |
repository_id
object ObrigatórioProperties of repository_id
Nome, Tipo, Descrição |
---|
repository_ids array of integers The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. |
repository_property_and_ref_name
object ObrigatórioConditions to target repositories by property and refs by name
Properties of repository_property_and_ref_name
Nome, Tipo, Descrição | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ref_name object | |||||||||||||
Properties of |
Nome, Tipo, Descrição |
---|
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. |
repository_property
object ObrigatórioProperties of repository_property
Nome, Tipo, Descrição | ||||
---|---|---|---|---|
include array of objects The repository properties and values to include. All of these properties must match for the condition to pass. | ||||
Properties of |
Nome, Tipo, Descrição |
---|
name string ObrigatórioThe name of the repository property to target |
property_values array of strings ObrigatórioThe values to match for the repository property |
source string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: |
exclude
array of objects The repository properties and values to exclude. The condition will not pass if any of these properties match.
Properties of exclude
Nome, Tipo, Descrição |
---|
name string ObrigatórioThe name of the repository property to target |
property_values array of strings ObrigatórioThe values to match for the repository property |
source string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: |
rules
array of objects An array of rules within the ruleset.
Can be one of these objects:
Nome, Tipo, Descrição | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
creation object ObrigatórioOnly allow users with bypass permission to create matching refs. | |||||||||||||
Properties of |
Nome, Tipo, Descrição |
---|
type string ObrigatórioValor: |
update
object ObrigatórioOnly allow users with bypass permission to update matching refs.
Properties of update
Nome, Tipo, Descrição | ||
---|---|---|
type string ObrigatórioValor: | ||
parameters object | ||
Properties of |
Nome, Tipo, Descrição |
---|
update_allows_fetch_and_merge boolean ObrigatórioBranch can pull changes from its upstream repository |
deletion
object ObrigatórioOnly allow users with bypass permissions to delete matching refs.
Properties of deletion
Nome, Tipo, Descrição |
---|
type string ObrigatórioValor: |
required_linear_history
object ObrigatórioPrevent merge commits from being pushed to matching refs.
Properties of required_linear_history
Nome, Tipo, Descrição |
---|
type string ObrigatórioValor: |
merge_queue
object ObrigatórioMerges must be performed via a merge queue.
Properties of merge_queue
Nome, Tipo, Descrição | ||||||||
---|---|---|---|---|---|---|---|---|
type string ObrigatórioValor: | ||||||||
parameters object | ||||||||
Properties of |
Nome, Tipo, Descrição |
---|
check_response_timeout_minutes integer ObrigatórioMaximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed |
grouping_strategy string ObrigatórioWhen set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. Pode ser um dos: |
max_entries_to_build integer ObrigatórioLimit the number of queued pull requests requesting checks and workflow runs at the same time. |
max_entries_to_merge integer ObrigatórioThe maximum number of PRs that will be merged together in a group. |
merge_method string ObrigatórioMethod to use when merging changes from queued pull requests. Pode ser um dos: |
min_entries_to_merge integer ObrigatórioThe minimum number of PRs that will be merged together in a group. |
min_entries_to_merge_wait_minutes integer ObrigatórioThe time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. |
required_deployments
object ObrigatórioChoose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
Properties of required_deployments
Nome, Tipo, Descrição | ||
---|---|---|
type string ObrigatórioValor: | ||
parameters object | ||
Properties of |
Nome, Tipo, Descrição |
---|
required_deployment_environments array of strings ObrigatórioThe environments that must be successfully deployed to before branches can be merged. |
required_signatures
object ObrigatórioCommits pushed to matching refs must have verified signatures.
Properties of required_signatures
Nome, Tipo, Descrição |
---|
type string ObrigatórioValor: |
pull_request
object ObrigatórioRequire all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Properties of pull_request
Nome, Tipo, Descrição | ||||||
---|---|---|---|---|---|---|
type string ObrigatórioValor: | ||||||
parameters object | ||||||
Properties of |
Nome, Tipo, Descrição |
---|
dismiss_stale_reviews_on_push boolean ObrigatórioNew, reviewable commits pushed will dismiss previous pull request review approvals. |
require_code_owner_review boolean ObrigatórioRequire an approving review in pull requests that modify files that have a designated code owner. |
require_last_push_approval boolean ObrigatórioWhether the most recent reviewable push must be approved by someone other than the person who pushed it. |
required_approving_review_count integer ObrigatórioThe number of approving reviews that are required before a pull request can be merged. |
required_review_thread_resolution boolean ObrigatórioAll conversations on code must be resolved before a pull request can be merged. |
required_status_checks
object ObrigatórioChoose 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
Nome, Tipo, Descrição | ||||||||
---|---|---|---|---|---|---|---|---|
type string ObrigatórioValor: | ||||||||
parameters object | ||||||||
Properties of |
Nome, Tipo, Descrição | |||
---|---|---|---|
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 ObrigatórioStatus checks that are required. | |||
Properties of |
Nome, Tipo, Descrição |
---|
context string ObrigatórioThe 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 ObrigatórioWhether 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 ObrigatórioPrevent users with push access from force pushing to refs.
Properties of non_fast_forward
Nome, Tipo, Descrição |
---|
type string ObrigatórioValor: |
commit_message_pattern
object ObrigatórioParameters to be used for the commit_message_pattern rule
Properties of commit_message_pattern
Nome, Tipo, Descrição | |||||
---|---|---|---|---|---|
type string ObrigatórioValor: | |||||
parameters object | |||||
Properties of |
Nome, Tipo, Descrição |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObrigatórioThe operator to use for matching. Pode ser um dos: |
pattern string ObrigatórioThe pattern to match with. |
commit_author_email_pattern
object ObrigatórioParameters to be used for the commit_author_email_pattern rule
Nome, Tipo, Descrição | |||||
---|---|---|---|---|---|
type string ObrigatórioValor: | |||||
parameters object | |||||
Properties of |
Nome, Tipo, Descrição |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObrigatórioThe operator to use for matching. Pode ser um dos: |
pattern string ObrigatórioThe pattern to match with. |
committer_email_pattern
object ObrigatórioParameters to be used for the committer_email_pattern rule
Properties of committer_email_pattern
Nome, Tipo, Descrição | |||||
---|---|---|---|---|---|
type string ObrigatórioValor: | |||||
parameters object | |||||
Properties of |
Nome, Tipo, Descrição |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObrigatórioThe operator to use for matching. Pode ser um dos: |
pattern string ObrigatórioThe pattern to match with. |
branch_name_pattern
object ObrigatórioParameters to be used for the branch_name_pattern rule
Properties of branch_name_pattern
Nome, Tipo, Descrição | |||||
---|---|---|---|---|---|
type string ObrigatórioValor: | |||||
parameters object | |||||
Properties of |
Nome, Tipo, Descrição |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObrigatórioThe operator to use for matching. Pode ser um dos: |
pattern string ObrigatórioThe pattern to match with. |
tag_name_pattern
object ObrigatórioParameters to be used for the tag_name_pattern rule
Properties of tag_name_pattern
Nome, Tipo, Descrição | |||||
---|---|---|---|---|---|
type string ObrigatórioValor: | |||||
parameters object | |||||
Properties of |
Nome, Tipo, Descrição |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObrigatórioThe operator to use for matching. Pode ser um dos: |
pattern string ObrigatórioThe pattern to match with. |
file_path_restriction
object ObrigatórioPrevent commits that include changes in specified file paths from being pushed to the commit graph.
Properties of file_path_restriction
Nome, Tipo, Descrição | ||
---|---|---|
type string ObrigatórioValor: | ||
parameters object | ||
Properties of |
Nome, Tipo, Descrição |
---|
restricted_file_paths array of strings ObrigatórioThe file paths that are restricted from being pushed to the commit graph. |
max_file_path_length
object ObrigatórioPrevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.
Properties of max_file_path_length
Nome, Tipo, Descrição | ||
---|---|---|
type string ObrigatórioValor: | ||
parameters object | ||
Properties of |
Nome, Tipo, Descrição |
---|
max_file_path_length integer ObrigatórioThe maximum amount of characters allowed in file paths |
file_extension_restriction
object ObrigatórioPrevent commits that include files with specified file extensions from being pushed to the commit graph.
Properties of file_extension_restriction
Nome, Tipo, Descrição | ||
---|---|---|
type string ObrigatórioValor: | ||
parameters object | ||
Properties of |
Nome, Tipo, Descrição |
---|
restricted_file_extensions array of strings ObrigatórioThe file extensions that are restricted from being pushed to the commit graph. |
max_file_size
object ObrigatórioPrevent commits that exceed a specified file size limit from being pushed to the commit.
Properties of max_file_size
Nome, Tipo, Descrição | ||
---|---|---|
type string ObrigatórioValor: | ||
parameters object | ||
Properties of |
Nome, Tipo, Descrição |
---|
max_file_size integer ObrigatórioThe maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). |
workflows
object ObrigatórioRequire all changes made to a targeted branch to pass the specified workflows before they can be merged.
Properties of workflows
Nome, Tipo, Descrição | |||||||||
---|---|---|---|---|---|---|---|---|---|
type string ObrigatórioValor: | |||||||||
parameters object | |||||||||
Properties of |
Nome, Tipo, Descrição | |||||
---|---|---|---|---|---|
do_not_enforce_on_create boolean Allow repositories and branches to be created if a check would otherwise prohibit it. | |||||
workflows array of objects ObrigatórioWorkflows that must pass for this rule to pass. | |||||
Properties of |
Nome, Tipo, Descrição |
---|
path string ObrigatórioThe path to the workflow file |
ref string The ref (branch or tag) of the workflow file to use |
repository_id integer ObrigatórioThe ID of the repository where the workflow is defined |
sha string The commit SHA of the workflow file to use |
code_scanning
object ObrigatórioChoose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
Properties of code_scanning
Nome, Tipo, Descrição | |||||||
---|---|---|---|---|---|---|---|
type string ObrigatórioValor: | |||||||
parameters object | |||||||
Properties of |
Nome, Tipo, Descrição | ||||
---|---|---|---|---|
code_scanning_tools array of objects ObrigatórioTools that must provide code scanning results for this rule to pass. | ||||
Properties of |
Nome, Tipo, Descrição |
---|
alerts_threshold string ObrigatórioThe severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts." Pode ser um dos: |
security_alerts_threshold string ObrigatórioThe severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts." Pode ser um dos: |
tool string ObrigatórioThe name of a code scanning tool |
Códigos de status de resposta HTTP para "Create an organization repository ruleset"
Código de status | Descrição |
---|---|
201 | Created |
404 | Resource not found |
500 | Internal Error |
Exemplos de código para "Create an organization repository ruleset"
Exemplo de solicitação
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","bypass_mode":"always"}],"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"}}]}'
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",
"bypass_mode": "always"
}
],
"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"
}
}
],
"node_id": "RRS_lACkVXNlcgQB",
"_links": {
"self": {
"href": "https://api.github.com/orgs/my-org/rulesets/21"
},
"html": {
"href": "https://github.com/organizations/my-org/settings/rules/21"
}
},
"created_at": "2023-08-15T08:43:03Z",
"updated_at": "2023-09-23T16:29:47Z"
}
Get an organization repository ruleset
Get a repository ruleset for an organization.
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.
Tokens de acesso refinados para "Get an organization repository ruleset"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
- Tokens de acesso de usuário do aplicativo GitHub
- Tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinado deve ter os seguintes conjuntos de permissões:
- "Administration" organization permissions (write)
Parâmetros para "Get an organization repository ruleset"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
ruleset_id integer ObrigatórioThe ID of the ruleset. |
Códigos de status de resposta HTTP para "Get an organization repository ruleset"
Código de status | Descrição |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
Exemplos de código para "Get an organization repository ruleset"
Exemplo de solicitação
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",
"bypass_mode": "always"
}
],
"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"
}
}
],
"node_id": "RRS_lACkVXNlcgQB",
"_links": {
"self": {
"href": "https://api.github.com/orgs/my-org/rulesets/21"
},
"html": {
"href": "https://github.com/organizations/my-org/settings/rules/21"
}
},
"created_at": "2023-08-15T08:43:03Z",
"updated_at": "2023-09-23T16:29:47Z"
}
Update an organization repository ruleset
Update a ruleset for an organization.
Tokens de acesso refinados para "Update an organization repository ruleset"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
- Tokens de acesso de usuário do aplicativo GitHub
- Tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinado deve ter os seguintes conjuntos de permissões:
- "Administration" organization permissions (write)
Parâmetros para "Update an organization repository ruleset"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
ruleset_id integer ObrigatórioThe ID of the ruleset. |
Nome, Tipo, Descrição | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name string The name of the ruleset. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target string The target of the ruleset Pode ser um dos: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enforcement string The enforcement level of the ruleset. Pode ser um dos: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bypass_actors array of objects The actors that can bypass the rules in this ruleset | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties of |
Nome, Tipo, Descrição |
---|
actor_id integer or null The ID of the actor that can bypass a ruleset. If |
actor_type string ObrigatórioThe type of actor that can bypass a ruleset Pode ser um dos: |
bypass_mode string When the specified actor can bypass the ruleset. Padrão: Pode ser um dos: |
conditions
object Conditions for an organization ruleset.
The branch and tag rulesets conditions object should contain both repository_name
and ref_name
properties, or both repository_id
and ref_name
properties, or both repository_property
and ref_name
properties.
The push rulesets conditions object does not require the ref_name
property.
Can be one of these objects:
Nome, Tipo, Descrição | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
repository_name_and_ref_name object ObrigatórioConditions to target repositories by name and refs by name | |||||||||||||||||||||
Properties of |
Nome, Tipo, Descrição | ||||
---|---|---|---|---|
ref_name object | ||||
Properties of |
Nome, Tipo, Descrição |
---|
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. |
repository_name
object ObrigatórioProperties of repository_name
Nome, Tipo, Descrição |
---|
include array of strings Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts |
exclude array of strings Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. |
protected boolean Whether renaming of target repositories is prevented. |
repository_id_and_ref_name
object ObrigatórioConditions to target repositories by id and refs by name
Properties of repository_id_and_ref_name
Nome, Tipo, Descrição | |||
---|---|---|---|
ref_name object | |||
Properties of |
Nome, Tipo, Descrição |
---|
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. |
repository_id
object ObrigatórioProperties of repository_id
Nome, Tipo, Descrição |
---|
repository_ids array of integers The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. |
repository_property_and_ref_name
object ObrigatórioConditions to target repositories by property and refs by name
Properties of repository_property_and_ref_name
Nome, Tipo, Descrição | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ref_name object | |||||||||||||
Properties of |
Nome, Tipo, Descrição |
---|
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. |
repository_property
object ObrigatórioProperties of repository_property
Nome, Tipo, Descrição | ||||
---|---|---|---|---|
include array of objects The repository properties and values to include. All of these properties must match for the condition to pass. | ||||
Properties of |
Nome, Tipo, Descrição |
---|
name string ObrigatórioThe name of the repository property to target |
property_values array of strings ObrigatórioThe values to match for the repository property |
source string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: |
exclude
array of objects The repository properties and values to exclude. The condition will not pass if any of these properties match.
Properties of exclude
Nome, Tipo, Descrição |
---|
name string ObrigatórioThe name of the repository property to target |
property_values array of strings ObrigatórioThe values to match for the repository property |
source string The source of the repository property. Defaults to 'custom' if not specified. Pode ser um dos: |
rules
array of objects An array of rules within the ruleset.
Can be one of these objects:
Nome, Tipo, Descrição | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
creation object ObrigatórioOnly allow users with bypass permission to create matching refs. | |||||||||||||
Properties of |
Nome, Tipo, Descrição |
---|
type string ObrigatórioValor: |
update
object ObrigatórioOnly allow users with bypass permission to update matching refs.
Properties of update
Nome, Tipo, Descrição | ||
---|---|---|
type string ObrigatórioValor: | ||
parameters object | ||
Properties of |
Nome, Tipo, Descrição |
---|
update_allows_fetch_and_merge boolean ObrigatórioBranch can pull changes from its upstream repository |
deletion
object ObrigatórioOnly allow users with bypass permissions to delete matching refs.
Properties of deletion
Nome, Tipo, Descrição |
---|
type string ObrigatórioValor: |
required_linear_history
object ObrigatórioPrevent merge commits from being pushed to matching refs.
Properties of required_linear_history
Nome, Tipo, Descrição |
---|
type string ObrigatórioValor: |
merge_queue
object ObrigatórioMerges must be performed via a merge queue.
Properties of merge_queue
Nome, Tipo, Descrição | ||||||||
---|---|---|---|---|---|---|---|---|
type string ObrigatórioValor: | ||||||||
parameters object | ||||||||
Properties of |
Nome, Tipo, Descrição |
---|
check_response_timeout_minutes integer ObrigatórioMaximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed |
grouping_strategy string ObrigatórioWhen set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. Pode ser um dos: |
max_entries_to_build integer ObrigatórioLimit the number of queued pull requests requesting checks and workflow runs at the same time. |
max_entries_to_merge integer ObrigatórioThe maximum number of PRs that will be merged together in a group. |
merge_method string ObrigatórioMethod to use when merging changes from queued pull requests. Pode ser um dos: |
min_entries_to_merge integer ObrigatórioThe minimum number of PRs that will be merged together in a group. |
min_entries_to_merge_wait_minutes integer ObrigatórioThe time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. |
required_deployments
object ObrigatórioChoose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
Properties of required_deployments
Nome, Tipo, Descrição | ||
---|---|---|
type string ObrigatórioValor: | ||
parameters object | ||
Properties of |
Nome, Tipo, Descrição |
---|
required_deployment_environments array of strings ObrigatórioThe environments that must be successfully deployed to before branches can be merged. |
required_signatures
object ObrigatórioCommits pushed to matching refs must have verified signatures.
Properties of required_signatures
Nome, Tipo, Descrição |
---|
type string ObrigatórioValor: |
pull_request
object ObrigatórioRequire all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Properties of pull_request
Nome, Tipo, Descrição | ||||||
---|---|---|---|---|---|---|
type string ObrigatórioValor: | ||||||
parameters object | ||||||
Properties of |
Nome, Tipo, Descrição |
---|
dismiss_stale_reviews_on_push boolean ObrigatórioNew, reviewable commits pushed will dismiss previous pull request review approvals. |
require_code_owner_review boolean ObrigatórioRequire an approving review in pull requests that modify files that have a designated code owner. |
require_last_push_approval boolean ObrigatórioWhether the most recent reviewable push must be approved by someone other than the person who pushed it. |
required_approving_review_count integer ObrigatórioThe number of approving reviews that are required before a pull request can be merged. |
required_review_thread_resolution boolean ObrigatórioAll conversations on code must be resolved before a pull request can be merged. |
required_status_checks
object ObrigatórioChoose 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
Nome, Tipo, Descrição | ||||||||
---|---|---|---|---|---|---|---|---|
type string ObrigatórioValor: | ||||||||
parameters object | ||||||||
Properties of |
Nome, Tipo, Descrição | |||
---|---|---|---|
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 ObrigatórioStatus checks that are required. | |||
Properties of |
Nome, Tipo, Descrição |
---|
context string ObrigatórioThe 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 ObrigatórioWhether 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 ObrigatórioPrevent users with push access from force pushing to refs.
Properties of non_fast_forward
Nome, Tipo, Descrição |
---|
type string ObrigatórioValor: |
commit_message_pattern
object ObrigatórioParameters to be used for the commit_message_pattern rule
Properties of commit_message_pattern
Nome, Tipo, Descrição | |||||
---|---|---|---|---|---|
type string ObrigatórioValor: | |||||
parameters object | |||||
Properties of |
Nome, Tipo, Descrição |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObrigatórioThe operator to use for matching. Pode ser um dos: |
pattern string ObrigatórioThe pattern to match with. |
commit_author_email_pattern
object ObrigatórioParameters to be used for the commit_author_email_pattern rule
Nome, Tipo, Descrição | |||||
---|---|---|---|---|---|
type string ObrigatórioValor: | |||||
parameters object | |||||
Properties of |
Nome, Tipo, Descrição |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObrigatórioThe operator to use for matching. Pode ser um dos: |
pattern string ObrigatórioThe pattern to match with. |
committer_email_pattern
object ObrigatórioParameters to be used for the committer_email_pattern rule
Properties of committer_email_pattern
Nome, Tipo, Descrição | |||||
---|---|---|---|---|---|
type string ObrigatórioValor: | |||||
parameters object | |||||
Properties of |
Nome, Tipo, Descrição |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObrigatórioThe operator to use for matching. Pode ser um dos: |
pattern string ObrigatórioThe pattern to match with. |
branch_name_pattern
object ObrigatórioParameters to be used for the branch_name_pattern rule
Properties of branch_name_pattern
Nome, Tipo, Descrição | |||||
---|---|---|---|---|---|
type string ObrigatórioValor: | |||||
parameters object | |||||
Properties of |
Nome, Tipo, Descrição |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObrigatórioThe operator to use for matching. Pode ser um dos: |
pattern string ObrigatórioThe pattern to match with. |
tag_name_pattern
object ObrigatórioParameters to be used for the tag_name_pattern rule
Properties of tag_name_pattern
Nome, Tipo, Descrição | |||||
---|---|---|---|---|---|
type string ObrigatórioValor: | |||||
parameters object | |||||
Properties of |
Nome, Tipo, Descrição |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObrigatórioThe operator to use for matching. Pode ser um dos: |
pattern string ObrigatórioThe pattern to match with. |
file_path_restriction
object ObrigatórioPrevent commits that include changes in specified file paths from being pushed to the commit graph.
Properties of file_path_restriction
Nome, Tipo, Descrição | ||
---|---|---|
type string ObrigatórioValor: | ||
parameters object | ||
Properties of |
Nome, Tipo, Descrição |
---|
restricted_file_paths array of strings ObrigatórioThe file paths that are restricted from being pushed to the commit graph. |
max_file_path_length
object ObrigatórioPrevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.
Properties of max_file_path_length
Nome, Tipo, Descrição | ||
---|---|---|
type string ObrigatórioValor: | ||
parameters object | ||
Properties of |
Nome, Tipo, Descrição |
---|
max_file_path_length integer ObrigatórioThe maximum amount of characters allowed in file paths |
file_extension_restriction
object ObrigatórioPrevent commits that include files with specified file extensions from being pushed to the commit graph.
Properties of file_extension_restriction
Nome, Tipo, Descrição | ||
---|---|---|
type string ObrigatórioValor: | ||
parameters object | ||
Properties of |
Nome, Tipo, Descrição |
---|
restricted_file_extensions array of strings ObrigatórioThe file extensions that are restricted from being pushed to the commit graph. |
max_file_size
object ObrigatórioPrevent commits that exceed a specified file size limit from being pushed to the commit.
Properties of max_file_size
Nome, Tipo, Descrição | ||
---|---|---|
type string ObrigatórioValor: | ||
parameters object | ||
Properties of |
Nome, Tipo, Descrição |
---|
max_file_size integer ObrigatórioThe maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). |
workflows
object ObrigatórioRequire all changes made to a targeted branch to pass the specified workflows before they can be merged.
Properties of workflows
Nome, Tipo, Descrição | |||||||||
---|---|---|---|---|---|---|---|---|---|
type string ObrigatórioValor: | |||||||||
parameters object | |||||||||
Properties of |
Nome, Tipo, Descrição | |||||
---|---|---|---|---|---|
do_not_enforce_on_create boolean Allow repositories and branches to be created if a check would otherwise prohibit it. | |||||
workflows array of objects ObrigatórioWorkflows that must pass for this rule to pass. | |||||
Properties of |
Nome, Tipo, Descrição |
---|
path string ObrigatórioThe path to the workflow file |
ref string The ref (branch or tag) of the workflow file to use |
repository_id integer ObrigatórioThe ID of the repository where the workflow is defined |
sha string The commit SHA of the workflow file to use |
code_scanning
object ObrigatórioChoose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
Properties of code_scanning
Nome, Tipo, Descrição | |||||||
---|---|---|---|---|---|---|---|
type string ObrigatórioValor: | |||||||
parameters object | |||||||
Properties of |
Nome, Tipo, Descrição | ||||
---|---|---|---|---|
code_scanning_tools array of objects ObrigatórioTools that must provide code scanning results for this rule to pass. | ||||
Properties of |
Nome, Tipo, Descrição |
---|
alerts_threshold string ObrigatórioThe severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts." Pode ser um dos: |
security_alerts_threshold string ObrigatórioThe severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts." Pode ser um dos: |
tool string ObrigatórioThe name of a code scanning tool |
Códigos de status de resposta HTTP para "Update an organization repository ruleset"
Código de status | Descrição |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
Exemplos de código para "Update an organization repository ruleset"
Exemplo de solicitação
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","bypass_mode":"always"}],"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"}}]}'
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",
"bypass_mode": "always"
}
],
"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"
}
}
],
"node_id": "RRS_lACkVXNlcgQB",
"_links": {
"self": {
"href": "https://api.github.com/orgs/my-org/rulesets/21"
},
"html": {
"href": "https://github.com/organizations/my-org/settings/rules/21"
}
},
"created_at": "2023-08-15T08:43:03Z",
"updated_at": "2023-09-23T16:29:47Z"
}
Delete an organization repository ruleset
Delete a ruleset for an organization.
Tokens de acesso refinados para "Delete an organization repository ruleset"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
- Tokens de acesso de usuário do aplicativo GitHub
- Tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinado deve ter os seguintes conjuntos de permissões:
- "Administration" organization permissions (write)
Parâmetros para "Delete an organization repository ruleset"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
ruleset_id integer ObrigatórioThe ID of the ruleset. |
Códigos de status de resposta HTTP para "Delete an organization repository ruleset"
Código de status | Descrição |
---|---|
204 | No Content |
404 | Resource not found |
500 | Internal Error |
Exemplos de código para "Delete an organization repository ruleset"
Exemplo de solicitação
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