Skip to main content
Ahora la API de REST tiene control de versiones. Para obtener más información, consulta "Acerca del control de versiones de la API".

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:

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"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
owner string Requerido

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

repo string Requerido

The name of the repository without the .git extension. The name is not case sensitive.

branch string Requerido

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Parámetros de consulta
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: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Valor predeterminado: 1

Códigos de estado de respuesta HTTP para "Get rules for a branch"

status codeDescripción
200

OK

Ejemplos de código para "Get rules for a branch"

Ejemplo de solicitud

get/repos/{owner}/{repo}/rules/branches/{branch}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ 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:

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"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
owner string Requerido

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

repo string Requerido

The name of the repository without the .git extension. The name is not case sensitive.

Parámetros de consulta
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: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Valor predeterminado: 1

includes_parents boolean

Include rulesets configured at higher levels that apply to this repository

Valor predeterminado: true

Códigos de estado de respuesta HTTP para "Get all repository rulesets"

status codeDescripción
200

OK

404

Resource not found

500

Internal Error

Ejemplos de código para "Get all repository rulesets"

Ejemplo de solicitud

get/repos/{owner}/{repo}/rulesets
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ 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:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Administration" repository permissions (write)

Parámetros para "Create a repository ruleset"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
owner string Requerido

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

repo string Requerido

The name of the repository without the .git extension. The name is not case sensitive.

Parámetros del cuerpo
Nombre, Tipo, Descripción
name string Requerido

The name of the ruleset.

target string

The target of the ruleset.

Puede ser uno de los siguientes: branch, tag

enforcement string Requerido

The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.

Puede ser uno de los siguientes: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Nombre, Tipo, Descripción
actor_id integer Requerido

The ID of the actor that can bypass a ruleset. If actor_type is OrganizationAdmin, this should be 1.

actor_type string Requerido

The type of actor that can bypass a ruleset

Puede ser uno de los siguientes: Integration, OrganizationAdmin, RepositoryRole, Team

bypass_mode string Requerido

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type.

Puede ser uno de los siguientes: always, pull_request

conditions object

Parameters for a repository ruleset ref name condition

Nombre, Tipo, Descripción
ref_name object
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 ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

rules array of objects

An array of rules within the ruleset.

Nombre, Tipo, Descripción
creation object Requerido

Only allow users with bypass permission to create matching refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: creation

update object Requerido

Only allow users with bypass permission to update matching refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: update

parameters object
Nombre, Tipo, Descripción
update_allows_fetch_and_merge boolean Requerido

Branch can pull changes from its upstream repository

deletion object Requerido

Only allow users with bypass permissions to delete matching refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: deletion

required_linear_history object Requerido

Prevent merge commits from being pushed to matching refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: required_linear_history

required_deployments object Requerido

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

Nombre, Tipo, Descripción
type string Requerido

Valor: required_deployments

parameters object
Nombre, Tipo, Descripción
required_deployment_environments array of strings Requerido

The environments that must be successfully deployed to before branches can be merged.

required_signatures object Requerido

Commits pushed to matching refs must have verified signatures.

Nombre, Tipo, Descripción
type string Requerido

Valor: required_signatures

pull_request object Requerido

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

Nombre, Tipo, Descripción
type string Requerido

Valor: pull_request

parameters object
Nombre, Tipo, Descripción
dismiss_stale_reviews_on_push boolean Requerido

New, reviewable commits pushed will dismiss previous pull request review approvals.

require_code_owner_review boolean Requerido

Require an approving review in pull requests that modify files that have a designated code owner.

require_last_push_approval boolean Requerido

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

required_approving_review_count integer Requerido

The number of approving reviews that are required before a pull request can be merged.

required_review_thread_resolution boolean Requerido

All conversations on code must be resolved before a pull request can be merged.

required_status_checks object Requerido

Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.

Nombre, Tipo, Descripción
type string Requerido

Valor: required_status_checks

parameters object
Nombre, Tipo, Descripción
required_status_checks array of objects Requerido

Status checks that are required.

Nombre, Tipo, Descripción
context string Requerido

The status check context name that must be present on the commit.

integration_id integer

The optional integration ID that this status check must originate from.

strict_required_status_checks_policy boolean Requerido

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

non_fast_forward object Requerido

Prevent users with push access from force pushing to refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: non_fast_forward

commit_message_pattern object Requerido

Parameters to be used for the commit_message_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: commit_message_pattern

parameters object
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 Requerido

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Requerido

The pattern to match with.

commit_author_email_pattern object Requerido

Parameters to be used for the commit_author_email_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: commit_author_email_pattern

parameters object
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 Requerido

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Requerido

The pattern to match with.

committer_email_pattern object Requerido

Parameters to be used for the committer_email_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: committer_email_pattern

parameters object
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 Requerido

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Requerido

The pattern to match with.

branch_name_pattern object Requerido

Parameters to be used for the branch_name_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: branch_name_pattern

parameters object
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 Requerido

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Requerido

The pattern to match with.

tag_name_pattern object Requerido

Parameters to be used for the tag_name_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: tag_name_pattern

parameters object
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 Requerido

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Requerido

The pattern to match with.

workflows object Requerido

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

Nombre, Tipo, Descripción
type string Requerido

Valor: workflows

parameters object
Nombre, Tipo, Descripción
workflows array of objects Requerido

Workflows that must pass for this rule to pass.

Nombre, Tipo, Descripción
path string Requerido

The path to the workflow file

ref string

The ref (branch or tag) of the workflow file to use

repository_id integer Requerido

The 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 codeDescripción
201

Created

404

Resource not found

500

Internal Error

Ejemplos de código para "Create a repository ruleset"

Ejemplo de solicitud

post/repos/{owner}/{repo}/rulesets
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ 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.

Tokens de acceso específicos para "Get a repository ruleset"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

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"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
owner string Requerido

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

repo string Requerido

The name of the repository without the .git extension. The name is not case sensitive.

ruleset_id integer Requerido

The ID of the ruleset.

Parámetros de consulta
Nombre, Tipo, Descripción
includes_parents boolean

Include rulesets configured at higher levels that apply to this repository

Valor predeterminado: true

Códigos de estado de respuesta HTTP para "Get a repository ruleset"

status codeDescripción
200

OK

404

Resource not found

500

Internal Error

Ejemplos de código para "Get a repository ruleset"

Ejemplo de solicitud

get/repos/{owner}/{repo}/rulesets/{ruleset_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ 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:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Administration" repository permissions (write)

Parámetros para "Update a repository ruleset"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
owner string Requerido

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

repo string Requerido

The name of the repository without the .git extension. The name is not case sensitive.

ruleset_id integer Requerido

The ID of the ruleset.

Parámetros del cuerpo
Nombre, Tipo, Descripción
name string

The name of the ruleset.

target string

The target of the ruleset.

Puede ser uno de los siguientes: branch, tag

enforcement string

The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.

Puede ser uno de los siguientes: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Nombre, Tipo, Descripción
actor_id integer Requerido

The ID of the actor that can bypass a ruleset. If actor_type is OrganizationAdmin, this should be 1.

actor_type string Requerido

The type of actor that can bypass a ruleset

Puede ser uno de los siguientes: Integration, OrganizationAdmin, RepositoryRole, Team

bypass_mode string Requerido

When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. pull_request is not applicable for the DeployKey actor type.

Puede ser uno de los siguientes: always, pull_request

conditions object

Parameters for a repository ruleset ref name condition

Nombre, Tipo, Descripción
ref_name object
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 ~DEFAULT_BRANCH to include the default branch or ~ALL to include all branches.

exclude array of strings

Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.

rules array of objects

An array of rules within the ruleset.

Nombre, Tipo, Descripción
creation object Requerido

Only allow users with bypass permission to create matching refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: creation

update object Requerido

Only allow users with bypass permission to update matching refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: update

parameters object
Nombre, Tipo, Descripción
update_allows_fetch_and_merge boolean Requerido

Branch can pull changes from its upstream repository

deletion object Requerido

Only allow users with bypass permissions to delete matching refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: deletion

required_linear_history object Requerido

Prevent merge commits from being pushed to matching refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: required_linear_history

required_deployments object Requerido

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

Nombre, Tipo, Descripción
type string Requerido

Valor: required_deployments

parameters object
Nombre, Tipo, Descripción
required_deployment_environments array of strings Requerido

The environments that must be successfully deployed to before branches can be merged.

required_signatures object Requerido

Commits pushed to matching refs must have verified signatures.

Nombre, Tipo, Descripción
type string Requerido

Valor: required_signatures

pull_request object Requerido

Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.

Nombre, Tipo, Descripción
type string Requerido

Valor: pull_request

parameters object
Nombre, Tipo, Descripción
dismiss_stale_reviews_on_push boolean Requerido

New, reviewable commits pushed will dismiss previous pull request review approvals.

require_code_owner_review boolean Requerido

Require an approving review in pull requests that modify files that have a designated code owner.

require_last_push_approval boolean Requerido

Whether the most recent reviewable push must be approved by someone other than the person who pushed it.

required_approving_review_count integer Requerido

The number of approving reviews that are required before a pull request can be merged.

required_review_thread_resolution boolean Requerido

All conversations on code must be resolved before a pull request can be merged.

required_status_checks object Requerido

Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.

Nombre, Tipo, Descripción
type string Requerido

Valor: required_status_checks

parameters object
Nombre, Tipo, Descripción
required_status_checks array of objects Requerido

Status checks that are required.

Nombre, Tipo, Descripción
context string Requerido

The status check context name that must be present on the commit.

integration_id integer

The optional integration ID that this status check must originate from.

strict_required_status_checks_policy boolean Requerido

Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.

non_fast_forward object Requerido

Prevent users with push access from force pushing to refs.

Nombre, Tipo, Descripción
type string Requerido

Valor: non_fast_forward

commit_message_pattern object Requerido

Parameters to be used for the commit_message_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: commit_message_pattern

parameters object
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 Requerido

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Requerido

The pattern to match with.

commit_author_email_pattern object Requerido

Parameters to be used for the commit_author_email_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: commit_author_email_pattern

parameters object
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 Requerido

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Requerido

The pattern to match with.

committer_email_pattern object Requerido

Parameters to be used for the committer_email_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: committer_email_pattern

parameters object
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 Requerido

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Requerido

The pattern to match with.

branch_name_pattern object Requerido

Parameters to be used for the branch_name_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: branch_name_pattern

parameters object
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 Requerido

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Requerido

The pattern to match with.

tag_name_pattern object Requerido

Parameters to be used for the tag_name_pattern rule

Nombre, Tipo, Descripción
type string Requerido

Valor: tag_name_pattern

parameters object
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 Requerido

The operator to use for matching.

Puede ser uno de los siguientes: starts_with, ends_with, contains, regex

pattern string Requerido

The pattern to match with.

workflows object Requerido

Require all changes made to a targeted branch to pass the specified workflows before they can be merged.

Nombre, Tipo, Descripción
type string Requerido

Valor: workflows

parameters object
Nombre, Tipo, Descripción
workflows array of objects Requerido

Workflows that must pass for this rule to pass.

Nombre, Tipo, Descripción
path string Requerido

The path to the workflow file

ref string

The ref (branch or tag) of the workflow file to use

repository_id integer Requerido

The 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 codeDescripción
200

OK

404

Resource not found

500

Internal Error

Ejemplos de código para "Update a repository ruleset"

Ejemplo de solicitud

put/repos/{owner}/{repo}/rulesets/{ruleset_id}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ 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:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Administration" repository permissions (write)

Parámetros para "Delete a repository ruleset"

Encabezados
Nombre, Tipo, Descripción
accept string

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
owner string Requerido

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

repo string Requerido

The name of the repository without the .git extension. The name is not case sensitive.

ruleset_id integer Requerido

The ID of the ruleset.

Códigos de estado de respuesta HTTP para "Delete a repository ruleset"

status codeDescripción
204

No Content

404

Resource not found

500

Internal Error

Ejemplos de código para "Delete a repository ruleset"

Ejemplo de solicitud

delete/repos/{owner}/{repo}/rulesets/{ruleset_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/rulesets/RULESET_ID

Response

Status: 204