Puntos de conexión de la API de REST para reglas
Usa la API REST para administrar conjuntos de reglas para repositorios. Los conjuntos de reglas controlan cómo los usuarios pueden interactuar con ramas y etiquetas seleccionadas de un repositorio.
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.
Tokens de acceso específicos para "Get rules for a branch"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Metadata" repository permissions (read)
Este punto de conexión se puede usar sin autenticación o los permisos mencionados anteriormente si solo se solicitan recursos públicos.
Parámetros para "Get rules for a branch"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
owner string RequeridoThe account owner of the repository. The name is not case sensitive. |
repo string RequeridoThe name of the repository without the |
branch string RequeridoThe name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API. |
Nombre, Tipo, Descripción |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Valor predeterminado: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: |
Códigos de estado de respuesta HTTP para "Get rules for a branch"
status code | Descripción |
---|---|
200 | OK |
Ejemplos de código para "Get rules for a branch"
Ejemplo de solicitud
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.
Tokens de acceso específicos para "Get all repository rulesets"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Metadata" repository permissions (read)
Este punto de conexión se puede usar sin autenticación o los permisos mencionados anteriormente si solo se solicitan recursos públicos.
Parámetros para "Get all repository rulesets"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
owner string RequeridoThe account owner of the repository. The name is not case sensitive. |
repo string RequeridoThe name of the repository without the |
Nombre, Tipo, Descripción |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Valor predeterminado: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: |
includes_parents boolean Include rulesets configured at higher levels that apply to this repository Valor predeterminado: |
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 estado de respuesta HTTP para "Get all repository rulesets"
status code | Descripción |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
Ejemplos de código para "Get all repository rulesets"
Ejemplo de solicitud
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.
Tokens de acceso específicos para "Create a repository ruleset"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Administration" repository permissions (write)
Parámetros para "Create a repository ruleset"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
owner string RequeridoThe account owner of the repository. The name is not case sensitive. |
repo string RequeridoThe name of the repository without the |
Nombre, Tipo, Descripción | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name string RequeridoThe name of the ruleset. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target string The target of the ruleset Valor predeterminado: Puede ser uno de los siguientes: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enforcement string RequeridoThe enforcement level of the ruleset. Puede ser uno de los siguientes: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bypass_actors array of objects The actors that can bypass the rules in this ruleset | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties of |
Nombre, Tipo, Descripción |
---|
actor_id integer RequeridoThe ID of the actor that can bypass a ruleset. If |
actor_type string RequeridoThe type of actor that can bypass a ruleset Puede ser uno de los siguientes: |
bypass_mode string RequeridoWhen the specified actor can bypass the ruleset. Valor predeterminado: Puede ser uno de los siguientes: |
conditions
object Parameters for a repository ruleset ref name condition
Properties of conditions
Nombre, Tipo, Descripción | |||
---|---|---|---|
ref_name object | |||
Properties of |
Nombre, Tipo, Descripción |
---|
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:
Nombre, Tipo, Descripción | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
creation object RequeridoOnly allow users with bypass permission to create matching refs. | |||||||||||||
Properties of |
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
update
object RequeridoOnly allow users with bypass permission to update matching refs.
Properties of update
Nombre, Tipo, Descripción | ||
---|---|---|
type string RequeridoValor: | ||
parameters object | ||
Properties of |
Nombre, Tipo, Descripción |
---|
update_allows_fetch_and_merge boolean RequeridoBranch can pull changes from its upstream repository |
deletion
object RequeridoOnly allow users with bypass permissions to delete matching refs.
Properties of deletion
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
required_linear_history
object RequeridoPrevent merge commits from being pushed to matching refs.
Properties of required_linear_history
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
required_deployments
object RequeridoChoose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
Properties of required_deployments
Nombre, Tipo, Descripción | ||
---|---|---|
type string RequeridoValor: | ||
parameters object | ||
Properties of |
Nombre, Tipo, Descripción |
---|
required_deployment_environments array of strings RequeridoThe environments that must be successfully deployed to before branches can be merged. |
required_signatures
object RequeridoCommits pushed to matching refs must have verified signatures.
Properties of required_signatures
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
pull_request
object RequeridoRequire all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Properties of pull_request
Nombre, Tipo, Descripción | ||||||
---|---|---|---|---|---|---|
type string RequeridoValor: | ||||||
parameters object | ||||||
Properties of |
Nombre, Tipo, Descripción |
---|
dismiss_stale_reviews_on_push boolean RequeridoNew, reviewable commits pushed will dismiss previous pull request review approvals. |
require_code_owner_review boolean RequeridoRequire an approving review in pull requests that modify files that have a designated code owner. |
require_last_push_approval boolean RequeridoWhether the most recent reviewable push must be approved by someone other than the person who pushed it. |
required_approving_review_count integer RequeridoThe number of approving reviews that are required before a pull request can be merged. |
required_review_thread_resolution boolean RequeridoAll conversations on code must be resolved before a pull request can be merged. |
required_status_checks
object RequeridoChoose 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
Nombre, Tipo, Descripción | ||||||||
---|---|---|---|---|---|---|---|---|
type string RequeridoValor: | ||||||||
parameters object | ||||||||
Properties of |
Nombre, Tipo, Descripción | |||
---|---|---|---|
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 RequeridoStatus checks that are required. | |||
Properties of |
Nombre, Tipo, Descripción |
---|
context string RequeridoThe 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 RequeridoWhether 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 RequeridoPrevent users with push access from force pushing to refs.
Properties of non_fast_forward
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
commit_message_pattern
object RequeridoParameters to be used for the commit_message_pattern rule
Properties of commit_message_pattern
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
Nombre, Tipo, Descripción |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
commit_author_email_pattern
object RequeridoParameters to be used for the commit_author_email_pattern rule
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
Nombre, Tipo, Descripción |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
committer_email_pattern
object RequeridoParameters to be used for the committer_email_pattern rule
Properties of committer_email_pattern
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
Nombre, Tipo, Descripción |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
branch_name_pattern
object RequeridoParameters to be used for the branch_name_pattern rule
Properties of branch_name_pattern
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
Nombre, Tipo, Descripción |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
tag_name_pattern
object RequeridoParameters to be used for the tag_name_pattern rule
Properties of tag_name_pattern
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
Nombre, Tipo, Descripción |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
workflows
object RequeridoRequire all changes made to a targeted branch to pass the specified workflows before they can be merged.
Properties of workflows
Nombre, Tipo, Descripción | |||||||||
---|---|---|---|---|---|---|---|---|---|
type string RequeridoValor: | |||||||||
parameters object | |||||||||
Properties of |
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
do_not_enforce_on_create boolean Allow repositories and branches to be created if a check would otherwise prohibit it. | |||||
workflows array of objects RequeridoWorkflows that must pass for this rule to pass. | |||||
Properties of |
Nombre, Tipo, Descripción |
---|
path string RequeridoThe path to the workflow file |
ref string The ref (branch or tag) of the workflow file to use |
repository_id integer RequeridoThe ID of the repository where the workflow is defined |
sha string The commit SHA of the workflow file to use |
Códigos de estado de respuesta HTTP para "Create a repository ruleset"
status code | Descripción |
---|---|
201 | Created |
404 | Resource not found |
500 | Internal Error |
Ejemplos de código para "Create a repository ruleset"
Ejemplo de solicitud
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.
Tokens de acceso específicos para "Get a repository ruleset"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Metadata" repository permissions (read)
Este punto de conexión se puede usar sin autenticación o los permisos mencionados anteriormente si solo se solicitan recursos públicos.
Parámetros para "Get a repository ruleset"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
owner string RequeridoThe account owner of the repository. The name is not case sensitive. |
repo string RequeridoThe name of the repository without the |
ruleset_id integer RequeridoThe ID of the ruleset. |
Nombre, Tipo, Descripción |
---|
includes_parents boolean Include rulesets configured at higher levels that apply to this repository Valor predeterminado: |
Códigos de estado de respuesta HTTP para "Get a repository ruleset"
status code | Descripción |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
Ejemplos de código para "Get a repository ruleset"
Ejemplo de solicitud
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.
Tokens de acceso específicos para "Update a repository ruleset"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Administration" repository permissions (write)
Parámetros para "Update a repository ruleset"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
owner string RequeridoThe account owner of the repository. The name is not case sensitive. |
repo string RequeridoThe name of the repository without the |
ruleset_id integer RequeridoThe ID of the ruleset. |
Nombre, Tipo, Descripción | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name string The name of the ruleset. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target string The target of the ruleset Puede ser uno de los siguientes: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enforcement string The enforcement level of the ruleset. Puede ser uno de los siguientes: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bypass_actors array of objects The actors that can bypass the rules in this ruleset | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties of |
Nombre, Tipo, Descripción |
---|
actor_id integer RequeridoThe ID of the actor that can bypass a ruleset. If |
actor_type string RequeridoThe type of actor that can bypass a ruleset Puede ser uno de los siguientes: |
bypass_mode string RequeridoWhen the specified actor can bypass the ruleset. Valor predeterminado: Puede ser uno de los siguientes: |
conditions
object Parameters for a repository ruleset ref name condition
Properties of conditions
Nombre, Tipo, Descripción | |||
---|---|---|---|
ref_name object | |||
Properties of |
Nombre, Tipo, Descripción |
---|
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:
Nombre, Tipo, Descripción | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
creation object RequeridoOnly allow users with bypass permission to create matching refs. | |||||||||||||
Properties of |
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
update
object RequeridoOnly allow users with bypass permission to update matching refs.
Properties of update
Nombre, Tipo, Descripción | ||
---|---|---|
type string RequeridoValor: | ||
parameters object | ||
Properties of |
Nombre, Tipo, Descripción |
---|
update_allows_fetch_and_merge boolean RequeridoBranch can pull changes from its upstream repository |
deletion
object RequeridoOnly allow users with bypass permissions to delete matching refs.
Properties of deletion
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
required_linear_history
object RequeridoPrevent merge commits from being pushed to matching refs.
Properties of required_linear_history
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
required_deployments
object RequeridoChoose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
Properties of required_deployments
Nombre, Tipo, Descripción | ||
---|---|---|
type string RequeridoValor: | ||
parameters object | ||
Properties of |
Nombre, Tipo, Descripción |
---|
required_deployment_environments array of strings RequeridoThe environments that must be successfully deployed to before branches can be merged. |
required_signatures
object RequeridoCommits pushed to matching refs must have verified signatures.
Properties of required_signatures
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
pull_request
object RequeridoRequire all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Properties of pull_request
Nombre, Tipo, Descripción | ||||||
---|---|---|---|---|---|---|
type string RequeridoValor: | ||||||
parameters object | ||||||
Properties of |
Nombre, Tipo, Descripción |
---|
dismiss_stale_reviews_on_push boolean RequeridoNew, reviewable commits pushed will dismiss previous pull request review approvals. |
require_code_owner_review boolean RequeridoRequire an approving review in pull requests that modify files that have a designated code owner. |
require_last_push_approval boolean RequeridoWhether the most recent reviewable push must be approved by someone other than the person who pushed it. |
required_approving_review_count integer RequeridoThe number of approving reviews that are required before a pull request can be merged. |
required_review_thread_resolution boolean RequeridoAll conversations on code must be resolved before a pull request can be merged. |
required_status_checks
object RequeridoChoose 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
Nombre, Tipo, Descripción | ||||||||
---|---|---|---|---|---|---|---|---|
type string RequeridoValor: | ||||||||
parameters object | ||||||||
Properties of |
Nombre, Tipo, Descripción | |||
---|---|---|---|
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 RequeridoStatus checks that are required. | |||
Properties of |
Nombre, Tipo, Descripción |
---|
context string RequeridoThe 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 RequeridoWhether 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 RequeridoPrevent users with push access from force pushing to refs.
Properties of non_fast_forward
Nombre, Tipo, Descripción |
---|
type string RequeridoValor: |
commit_message_pattern
object RequeridoParameters to be used for the commit_message_pattern rule
Properties of commit_message_pattern
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
Nombre, Tipo, Descripción |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
commit_author_email_pattern
object RequeridoParameters to be used for the commit_author_email_pattern rule
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
Nombre, Tipo, Descripción |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
committer_email_pattern
object RequeridoParameters to be used for the committer_email_pattern rule
Properties of committer_email_pattern
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
Nombre, Tipo, Descripción |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
branch_name_pattern
object RequeridoParameters to be used for the branch_name_pattern rule
Properties of branch_name_pattern
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
Nombre, Tipo, Descripción |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
tag_name_pattern
object RequeridoParameters to be used for the tag_name_pattern rule
Properties of tag_name_pattern
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
type string RequeridoValor: | |||||
parameters object | |||||
Properties of |
Nombre, Tipo, Descripción |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string RequeridoThe operator to use for matching. Puede ser uno de los siguientes: |
pattern string RequeridoThe pattern to match with. |
workflows
object RequeridoRequire all changes made to a targeted branch to pass the specified workflows before they can be merged.
Properties of workflows
Nombre, Tipo, Descripción | |||||||||
---|---|---|---|---|---|---|---|---|---|
type string RequeridoValor: | |||||||||
parameters object | |||||||||
Properties of |
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
do_not_enforce_on_create boolean Allow repositories and branches to be created if a check would otherwise prohibit it. | |||||
workflows array of objects RequeridoWorkflows that must pass for this rule to pass. | |||||
Properties of |
Nombre, Tipo, Descripción |
---|
path string RequeridoThe path to the workflow file |
ref string The ref (branch or tag) of the workflow file to use |
repository_id integer RequeridoThe ID of the repository where the workflow is defined |
sha string The commit SHA of the workflow file to use |
Códigos de estado de respuesta HTTP para "Update a repository ruleset"
status code | Descripción |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
Ejemplos de código para "Update a repository ruleset"
Ejemplo de solicitud
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.
Tokens de acceso específicos para "Delete a repository ruleset"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Administration" repository permissions (write)
Parámetros para "Delete a repository ruleset"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
owner string RequeridoThe account owner of the repository. The name is not case sensitive. |
repo string RequeridoThe name of the repository without the |
ruleset_id integer RequeridoThe ID of the ruleset. |
Códigos de estado de respuesta HTTP para "Delete a repository ruleset"
status code | Descripción |
---|---|
204 | No Content |
404 | Resource not found |
500 | Internal Error |
Ejemplos de código para "Delete a repository ruleset"
Ejemplo de solicitud
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