Rules - Документация по GitHub

Get all organization repository rulesets

Работа с GitHub Apps

Get all the repository rulesets for an organization.

Параметры для "Get all organization repository rulesets"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`org` string Обязательно The organization name. The name is not case sensitive.

Коды состояния HTTP-ответа для "Get all organization repository rulesets"

Код состояния	Описание
`200`	OK
`404`	Resource not found
`500`	Internal Error

Примеры кода для "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

Работа с GitHub Apps

Create a repository ruleset for an organization.

Параметры для "Create an organization repository ruleset"

Заголовки

Имя, Тип, Описание

accept string

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

Параметры пути

Имя, Тип, Описание

org string Обязательно

The organization name. The name is not case sensitive.

Параметры запроса

Имя, Тип, Описание

name string Обязательно

The name of the ruleset.

target string

The target of the ruleset.

Может быть одним из: 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 (evaluate is only available with GitHub Enterprise).

Может быть одним из: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Properties of bypass_actors

Имя, Тип, Описание
`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 Может быть одним из: `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:

Имя, Тип, Описание

creation object Обязательно

Parameters to be used for the creation rule

Properties of creation

Имя, Тип, Описание
`type` string Обязательно Значение: `creation`

update object Обязательно

Parameters to be used for the update rule

Properties of update

Имя, Тип, Описание

type string Обязательно

Значение: update

parameters object

Properties of parameters

Имя, Тип, Описание
`update_allows_fetch_and_merge` boolean Обязательно Branch can pull changes from its upstream repository

deletion object Обязательно

Parameters to be used for the deletion rule

Properties of deletion

Имя, Тип, Описание
`type` string Обязательно Значение: `deletion`

required_linear_history object Обязательно

Parameters to be used for the required_linear_history rule

Properties of required_linear_history

Имя, Тип, Описание
`type` string Обязательно Значение: `required_linear_history`

required_deployments object Обязательно

Parameters to be used for the required_deployments rule

Properties of required_deployments

Имя, Тип, Описание

type string Обязательно

Значение: required_deployments

parameters object

Properties of parameters

Имя, Тип, Описание
`required_deployment_environments` array of strings Обязательно The environments that must be successfully deployed to before branches can be merged.

required_signatures object Обязательно

Parameters to be used for the required_signatures rule

Properties of required_signatures

Имя, Тип, Описание
`type` string Обязательно Значение: `required_signatures`

pull_request object Обязательно

Parameters to be used for the pull_request rule

Properties of pull_request

Имя, Тип, Описание

type string Обязательно

Значение: pull_request

parameters object

Properties of parameters

Имя, Тип, Описание
`dismiss_stale_reviews_on_push` boolean Обязательно New, reviewable commits pushed will dismiss previous pull request review approvals.
`require_code_owner_review` boolean Обязательно Require an approving review in pull requests that modify files that have a designated code owner.
`require_last_push_approval` boolean Обязательно Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
`required_approving_review_count` integer Обязательно The number of approving reviews that are required before a pull request can be merged.
`required_review_thread_resolution` boolean Обязательно All conversations on code must be resolved before a pull request can be merged.

required_status_checks object Обязательно

Parameters to be used for the required_status_checks rule

Properties of required_status_checks

Имя, Тип, Описание

type string Обязательно

Значение: required_status_checks

parameters object

Properties of parameters

Имя, Тип, Описание

required_status_checks array of objects Обязательно

Status checks that are required.

Properties of required_status_checks

Имя, Тип, Описание
`context` string Обязательно 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 Обязательно

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 Обязательно

Parameters to be used for the non_fast_forward rule

Properties of non_fast_forward

Имя, Тип, Описание
`type` string Обязательно Значение: `non_fast_forward`

commit_message_pattern object Обязательно

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

Имя, Тип, Описание

type string Обязательно

Значение: commit_message_pattern

parameters object

Properties of parameters

Имя, Тип, Описание
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательно The operator to use for matching. Может быть одним из: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательно The pattern to match with.

commit_author_email_pattern object Обязательно

Parameters to be used for the commit_author_email_pattern rule

Properties of commit_author_email_pattern

Имя, Тип, Описание

type string Обязательно

Значение: commit_author_email_pattern

parameters object

Properties of parameters

Имя, Тип, Описание
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательно The operator to use for matching. Может быть одним из: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательно The pattern to match with.

committer_email_pattern object Обязательно

Parameters to be used for the committer_email_pattern rule

Properties of committer_email_pattern

Имя, Тип, Описание

type string Обязательно

Значение: committer_email_pattern

parameters object

Properties of parameters

Имя, Тип, Описание
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательно The operator to use for matching. Может быть одним из: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательно The pattern to match with.

branch_name_pattern object Обязательно

Parameters to be used for the branch_name_pattern rule

Properties of branch_name_pattern

Имя, Тип, Описание

type string Обязательно

Значение: branch_name_pattern

parameters object

Properties of parameters

Имя, Тип, Описание
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательно The operator to use for matching. Может быть одним из: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательно The pattern to match with.

tag_name_pattern object Обязательно

Parameters to be used for the tag_name_pattern rule

Properties of tag_name_pattern

Имя, Тип, Описание

type string Обязательно

Значение: tag_name_pattern

parameters object

Properties of parameters

Имя, Тип, Описание
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательно The operator to use for matching. Может быть одним из: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательно The pattern to match with.

Коды состояния HTTP-ответа для "Create an organization repository ruleset"

Код состояния	Описание
`201`	Created
`404`	Resource not found
`500`	Internal Error

Примеры кода для "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

Работа с GitHub Apps

Get a repository ruleset for an organization.

Параметры для "Get an organization repository ruleset"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`org` string Обязательно The organization name. The name is not case sensitive.
`ruleset_id` integer Обязательно The ID of the ruleset.

Коды состояния HTTP-ответа для "Get an organization repository ruleset"

Код состояния	Описание
`200`	OK
`404`	Resource not found
`500`	Internal Error

Примеры кода для "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

Работа с GitHub Apps

Update a ruleset for an organization.

Параметры для "Update an organization repository ruleset"

Заголовки

Имя, Тип, Описание

accept string

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

Параметры пути

Имя, Тип, Описание

org string Обязательно

The organization name. The name is not case sensitive.

ruleset_id integer Обязательно

The ID of the ruleset.

Параметры запроса

Имя, Тип, Описание

name string

The name of the ruleset.

target string

The target of the ruleset.

Может быть одним из: branch, tag

enforcement string

Может быть одним из: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Properties of bypass_actors

Имя, Тип, Описание
`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 Может быть одним из: `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:

Имя, Тип, Описание

creation object Обязательно

Parameters to be used for the creation rule

Properties of creation

Имя, Тип, Описание
`type` string Обязательно Значение: `creation`

update object Обязательно

Parameters to be used for the update rule

Properties of update

Имя, Тип, Описание

type string Обязательно

Значение: update

parameters object

Properties of parameters

Имя, Тип, Описание
`update_allows_fetch_and_merge` boolean Обязательно Branch can pull changes from its upstream repository

deletion object Обязательно

Parameters to be used for the deletion rule

Properties of deletion

Имя, Тип, Описание
`type` string Обязательно Значение: `deletion`

required_linear_history object Обязательно

Parameters to be used for the required_linear_history rule

Properties of required_linear_history

Имя, Тип, Описание
`type` string Обязательно Значение: `required_linear_history`

required_deployments object Обязательно

Parameters to be used for the required_deployments rule

Properties of required_deployments

Имя, Тип, Описание

type string Обязательно

Значение: required_deployments

parameters object

Properties of parameters

Имя, Тип, Описание
`required_deployment_environments` array of strings Обязательно The environments that must be successfully deployed to before branches can be merged.

required_signatures object Обязательно

Parameters to be used for the required_signatures rule

Properties of required_signatures

Имя, Тип, Описание
`type` string Обязательно Значение: `required_signatures`

pull_request object Обязательно

Parameters to be used for the pull_request rule

Properties of pull_request

Имя, Тип, Описание

type string Обязательно

Значение: pull_request

parameters object

Properties of parameters

Имя, Тип, Описание
`dismiss_stale_reviews_on_push` boolean Обязательно New, reviewable commits pushed will dismiss previous pull request review approvals.
`require_code_owner_review` boolean Обязательно Require an approving review in pull requests that modify files that have a designated code owner.
`require_last_push_approval` boolean Обязательно Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
`required_approving_review_count` integer Обязательно The number of approving reviews that are required before a pull request can be merged.
`required_review_thread_resolution` boolean Обязательно All conversations on code must be resolved before a pull request can be merged.

required_status_checks object Обязательно

Parameters to be used for the required_status_checks rule

Properties of required_status_checks

Имя, Тип, Описание

type string Обязательно

Значение: required_status_checks

parameters object

Properties of parameters

Имя, Тип, Описание

required_status_checks array of objects Обязательно

Status checks that are required.

Properties of required_status_checks

Имя, Тип, Описание
`context` string Обязательно 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 Обязательно

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 Обязательно

Parameters to be used for the non_fast_forward rule

Properties of non_fast_forward

Имя, Тип, Описание
`type` string Обязательно Значение: `non_fast_forward`

commit_message_pattern object Обязательно

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

Имя, Тип, Описание

type string Обязательно

Значение: commit_message_pattern

parameters object

Properties of parameters

Имя, Тип, Описание
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательно The operator to use for matching. Может быть одним из: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательно The pattern to match with.

commit_author_email_pattern object Обязательно

Parameters to be used for the commit_author_email_pattern rule

Properties of commit_author_email_pattern

Имя, Тип, Описание

type string Обязательно

Значение: commit_author_email_pattern

parameters object

Properties of parameters

Имя, Тип, Описание
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательно The operator to use for matching. Может быть одним из: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательно The pattern to match with.

committer_email_pattern object Обязательно

Parameters to be used for the committer_email_pattern rule

Properties of committer_email_pattern

Имя, Тип, Описание

type string Обязательно

Значение: committer_email_pattern

parameters object

Properties of parameters

Имя, Тип, Описание
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательно The operator to use for matching. Может быть одним из: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательно The pattern to match with.

branch_name_pattern object Обязательно

Parameters to be used for the branch_name_pattern rule

Properties of branch_name_pattern

Имя, Тип, Описание

type string Обязательно

Значение: branch_name_pattern

parameters object

Properties of parameters

Имя, Тип, Описание
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательно The operator to use for matching. Может быть одним из: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательно The pattern to match with.

tag_name_pattern object Обязательно

Parameters to be used for the tag_name_pattern rule

Properties of tag_name_pattern

Имя, Тип, Описание

type string Обязательно

Значение: tag_name_pattern

parameters object

Properties of parameters

Имя, Тип, Описание
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Обязательно The operator to use for matching. Может быть одним из: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Обязательно The pattern to match with.

Коды состояния HTTP-ответа для "Update an organization repository ruleset"

Код состояния	Описание
`200`	OK
`404`	Resource not found
`500`	Internal Error

Примеры кода для "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

Работа с GitHub Apps

Delete a ruleset for an organization.

Параметры для "Delete an organization repository ruleset"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`org` string Обязательно The organization name. The name is not case sensitive.
`ruleset_id` integer Обязательно The ID of the ruleset.

Коды состояния HTTP-ответа для "Delete an organization repository ruleset"

Код состояния	Описание
`204`	No Content
`404`	Resource not found
`500`	Internal Error

Примеры кода для "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