Regras - GitHub Docs

Get all organization repository rulesets

Get all the repository rulesets for an organization.

Parâmetros para "Get all organization repository rulesets"

Cabeçalhos
Name, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.
Parâmetros de caminho
Name, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.

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"

get/orgs/{org}/rulesets

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/rulesets

Response

Status: 200

[
  {
    "id": 21,
    "name": "super cool ruleset",
    "source_type": "Organization",
    "source": "my-org",
    "enforcement": "enabled"
  },
  {
    "id": 432,
    "name": "Another ruleset",
    "source_type": "Organization",
    "source": "my-org",
    "enforcement": "enabled"
  }
]

Create an organization repository ruleset

Funciona com GitHub Apps

Create a repository ruleset for an organization.

Parâmetros para "Create an organization repository ruleset"

Cabeçalhos

Name, Tipo, Descrição

accept string

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

Parâmetros de caminho

Name, Tipo, Descrição

org string Obrigatório

The organization name. The name is not case sensitive.

Parâmetros do corpo

Name, Tipo, Descrição

name string Obrigatório

The name of the ruleset.

target string

The target of the ruleset.

Pode ser um dos: branch, tag

enforcement string Obrigatório

The enforcement level of the ruleset. evaluate allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (evaluate is only available with GitHub Enterprise).

Pode ser um dos: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Properties of bypass_actors

Name, Tipo, Descrição
`actor_id` integer The ID of the actor that can bypass a ruleset
`actor_type` string The type of actor that can bypass a ruleset Pode ser um dos: `Team`, `Integration`

conditions object

Conditions for a organization ruleset

rules array of objects

An array of rules within the ruleset.

Can be one of these objects:

Name, Tipo, Descrição

creation object Obrigatório

Parameters to be used for the creation rule

Properties of creation

Name, Tipo, Descrição
`type` string Obrigatório Valor: `creation`

update object Obrigatório

Parameters to be used for the update rule

Properties of update

Name, Tipo, Descrição

type string Obrigatório

Valor: update

parameters object

Properties of parameters

Name, Tipo, Descrição
`update_allows_fetch_and_merge` boolean Obrigatório Branch can pull changes from its upstream repository

deletion object Obrigatório

Parameters to be used for the deletion rule

Properties of deletion

Name, Tipo, Descrição
`type` string Obrigatório Valor: `deletion`

required_linear_history object Obrigatório

Parameters to be used for the required_linear_history rule

Properties of required_linear_history

Name, Tipo, Descrição
`type` string Obrigatório Valor: `required_linear_history`

required_deployments object Obrigatório

Parameters to be used for the required_deployments rule

Properties of required_deployments

Name, Tipo, Descrição

type string Obrigatório

Valor: required_deployments

parameters object

Properties of parameters

Name, Tipo, Descrição
`required_deployment_environments` array of strings Obrigatório The environments that must be successfully deployed to before branches can be merged.

required_signatures object Obrigatório

Parameters to be used for the required_signatures rule

Properties of required_signatures

Name, Tipo, Descrição
`type` string Obrigatório Valor: `required_signatures`

pull_request object Obrigatório

Parameters to be used for the pull_request rule

Properties of pull_request

Name, Tipo, Descrição

type string Obrigatório

Valor: pull_request

parameters object

Properties of parameters

Name, Tipo, Descrição
`dismiss_stale_reviews_on_push` boolean Obrigatório New, reviewable commits pushed will dismiss previous pull request review approvals.
`require_code_owner_review` boolean Obrigatório Require an approving review in pull requests that modify files that have a designated code owner.
`require_last_push_approval` boolean Obrigatório Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
`required_approving_review_count` integer Obrigatório The number of approving reviews that are required before a pull request can be merged.
`required_review_thread_resolution` boolean Obrigatório All conversations on code must be resolved before a pull request can be merged.

required_status_checks object Obrigatório

Parameters to be used for the required_status_checks rule

Properties of required_status_checks

Name, Tipo, Descrição

type string Obrigatório

Valor: required_status_checks

parameters object

Properties of parameters

Name, Tipo, Descrição

required_status_checks array of objects Obrigatório

Status checks that are required.

Properties of required_status_checks

Name, Tipo, Descrição
`context` string Obrigatório 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 Obrigatório

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 Obrigatório

Parameters to be used for the non_fast_forward rule

Properties of non_fast_forward

Name, Tipo, Descrição
`type` string Obrigatório Valor: `non_fast_forward`

commit_message_pattern object Obrigatório

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

Name, Tipo, Descrição

type string Obrigatório

Valor: commit_message_pattern

parameters object

Properties of parameters

Name, 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ório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

commit_author_email_pattern object Obrigatório

Parameters to be used for the commit_author_email_pattern rule

Properties of commit_author_email_pattern

Name, Tipo, Descrição

type string Obrigatório

Valor: commit_author_email_pattern

parameters object

Properties of parameters

Name, 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ório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

committer_email_pattern object Obrigatório

Parameters to be used for the committer_email_pattern rule

Properties of committer_email_pattern

Name, Tipo, Descrição

type string Obrigatório

Valor: committer_email_pattern

parameters object

Properties of parameters

Name, 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ório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

branch_name_pattern object Obrigatório

Parameters to be used for the branch_name_pattern rule

Properties of branch_name_pattern

Name, Tipo, Descrição

type string Obrigatório

Valor: branch_name_pattern

parameters object

Properties of parameters

Name, 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ório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

tag_name_pattern object Obrigatório

Parameters to be used for the tag_name_pattern rule

Properties of tag_name_pattern

Name, Tipo, Descrição

type string Obrigatório

Valor: tag_name_pattern

parameters object

Properties of parameters

Name, 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ório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

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"

post/orgs/{org}/rulesets

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"}],"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": 21,
  "name": "super cool ruleset",
  "target": "branch",
  "source_type": "Organization",
  "source": "my-org",
  "enforcement": "active",
  "bypass_actors": [
    {
      "actor_id": 234,
      "actor_type": "Team"
    }
  ],
  "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"
      }
    }
  ]
}

Get an organization repository ruleset

Funciona com GitHub Apps

Get a repository ruleset for an organization.

Parâmetros para "Get an organization repository ruleset"

Cabeçalhos
Name, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.
Parâmetros de caminho
Name, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`ruleset_id` integer Obrigatório The 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"

get/orgs/{org}/rulesets/{ruleset_id}

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"
    }
  ],
  "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"
      }
    }
  ]
}

Update an organization repository ruleset

Funciona com GitHub Apps

Update a ruleset for an organization.

Parâmetros para "Update an organization repository ruleset"

Cabeçalhos

Name, Tipo, Descrição

accept string

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

Parâmetros de caminho

Name, Tipo, Descrição

org string Obrigatório

The organization name. The name is not case sensitive.

ruleset_id integer Obrigatório

The ID of the ruleset.

Parâmetros do corpo

Name, Tipo, Descrição

name string

The name of the ruleset.

target string

The target of the ruleset.

Pode ser um dos: branch, tag

enforcement string

Pode ser um dos: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Properties of bypass_actors

Name, Tipo, Descrição
`actor_id` integer The ID of the actor that can bypass a ruleset
`actor_type` string The type of actor that can bypass a ruleset Pode ser um dos: `Team`, `Integration`

conditions object

Conditions for a organization ruleset

rules array of objects

An array of rules within the ruleset.

Can be one of these objects:

Name, Tipo, Descrição

creation object Obrigatório

Parameters to be used for the creation rule

Properties of creation

Name, Tipo, Descrição
`type` string Obrigatório Valor: `creation`

update object Obrigatório

Parameters to be used for the update rule

Properties of update

Name, Tipo, Descrição

type string Obrigatório

Valor: update

parameters object

Properties of parameters

Name, Tipo, Descrição
`update_allows_fetch_and_merge` boolean Obrigatório Branch can pull changes from its upstream repository

deletion object Obrigatório

Parameters to be used for the deletion rule

Properties of deletion

Name, Tipo, Descrição
`type` string Obrigatório Valor: `deletion`

required_linear_history object Obrigatório

Parameters to be used for the required_linear_history rule

Properties of required_linear_history

Name, Tipo, Descrição
`type` string Obrigatório Valor: `required_linear_history`

required_deployments object Obrigatório

Parameters to be used for the required_deployments rule

Properties of required_deployments

Name, Tipo, Descrição

type string Obrigatório

Valor: required_deployments

parameters object

Properties of parameters

Name, Tipo, Descrição
`required_deployment_environments` array of strings Obrigatório The environments that must be successfully deployed to before branches can be merged.

required_signatures object Obrigatório

Parameters to be used for the required_signatures rule

Properties of required_signatures

Name, Tipo, Descrição
`type` string Obrigatório Valor: `required_signatures`

pull_request object Obrigatório

Parameters to be used for the pull_request rule

Properties of pull_request

Name, Tipo, Descrição

type string Obrigatório

Valor: pull_request

parameters object

Properties of parameters

Name, Tipo, Descrição
`dismiss_stale_reviews_on_push` boolean Obrigatório New, reviewable commits pushed will dismiss previous pull request review approvals.
`require_code_owner_review` boolean Obrigatório Require an approving review in pull requests that modify files that have a designated code owner.
`require_last_push_approval` boolean Obrigatório Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
`required_approving_review_count` integer Obrigatório The number of approving reviews that are required before a pull request can be merged.
`required_review_thread_resolution` boolean Obrigatório All conversations on code must be resolved before a pull request can be merged.

required_status_checks object Obrigatório

Parameters to be used for the required_status_checks rule

Properties of required_status_checks

Name, Tipo, Descrição

type string Obrigatório

Valor: required_status_checks

parameters object

Properties of parameters

Name, Tipo, Descrição

required_status_checks array of objects Obrigatório

Status checks that are required.

Properties of required_status_checks

Name, Tipo, Descrição
`context` string Obrigatório 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 Obrigatório

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 Obrigatório

Parameters to be used for the non_fast_forward rule

Properties of non_fast_forward

Name, Tipo, Descrição
`type` string Obrigatório Valor: `non_fast_forward`

commit_message_pattern object Obrigatório

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

Name, Tipo, Descrição

type string Obrigatório

Valor: commit_message_pattern

parameters object

Properties of parameters

Name, 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ório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

commit_author_email_pattern object Obrigatório

Parameters to be used for the commit_author_email_pattern rule

Properties of commit_author_email_pattern

Name, Tipo, Descrição

type string Obrigatório

Valor: commit_author_email_pattern

parameters object

Properties of parameters

Name, 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ório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

committer_email_pattern object Obrigatório

Parameters to be used for the committer_email_pattern rule

Properties of committer_email_pattern

Name, Tipo, Descrição

type string Obrigatório

Valor: committer_email_pattern

parameters object

Properties of parameters

Name, 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ório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

branch_name_pattern object Obrigatório

Parameters to be used for the branch_name_pattern rule

Properties of branch_name_pattern

Name, Tipo, Descrição

type string Obrigatório

Valor: branch_name_pattern

parameters object

Properties of parameters

Name, 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ório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

tag_name_pattern object Obrigatório

Parameters to be used for the tag_name_pattern rule

Properties of tag_name_pattern

Name, Tipo, Descrição

type string Obrigatório

Valor: tag_name_pattern

parameters object

Properties of parameters

Name, 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ório The operator to use for matching. Pode ser um dos: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Obrigatório The pattern to match with.

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"

put/orgs/{org}/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" \
  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"}],"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": 21,
  "name": "super cool ruleset",
  "target": "branch",
  "source_type": "Organization",
  "source": "my-org",
  "enforcement": "active",
  "bypass_actors": [
    {
      "actor_id": 234,
      "actor_type": "Team"
    }
  ],
  "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"
      }
    }
  ]
}

Delete an organization repository ruleset

Funciona com GitHub Apps

Delete a ruleset for an organization.

Parâmetros para "Delete an organization repository ruleset"

Cabeçalhos
Name, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.
Parâmetros de caminho
Name, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`ruleset_id` integer Obrigatório The 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"

delete/orgs/{org}/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" \
  https://api.github.com/orgs/ORG/rulesets/RULESET_ID

Response

Status: 204