REST-API-Endpunkte für Regeln - GitHub Enterprise Server 3.15 Docs

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.

Differenzierte Zugriffstoken für "Get rules for a branch"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Metadata" repository permissions (read)

Dieser Endpunkt kann ohne Authentifizierung oder die zuvor erwähnten Berechtigungen verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.

Parameter für „Get rules for a branch“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.
`branch` string Erforderlich The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Abfrageparameter
Name, type, BESCHREIBUNG
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Standard: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: `1`

HTTP-Antwortstatuscodes für „Get rules for a branch“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „Get rules for a branch“

Anforderungsbeispiel

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.

Differenzierte Zugriffstoken für "Get all repository rulesets"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Metadata" repository permissions (read)

Dieser Endpunkt kann ohne Authentifizierung oder die zuvor erwähnten Berechtigungen verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.

Parameter für „Get all repository rulesets“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.

Abfrageparameter
Name, type, BESCHREIBUNG
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Standard: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: `1`
`includes_parents` boolean Include rulesets configured at higher levels that apply to this repository Standard: `true`
`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, `branch,tag,push`.

HTTP-Antwortstatuscodes für „Get all repository rulesets“

Statuscode	BESCHREIBUNG
`200`	OK
`404`	Resource not found
`500`	Internal Error

Codebeispiele für „Get all repository rulesets“

Anforderungsbeispiel

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.

Differenzierte Zugriffstoken für "Create a repository ruleset"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Administration" repository permissions (write)

Parameter für „Create a repository ruleset“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.

Name, type, BESCHREIBUNG

name string Erforderlich

The name of the ruleset.

target string

The target of the ruleset

Standard: branch

Kann eine der Folgenden sein: branch, tag, push

enforcement string Erforderlich

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

Kann eine der Folgenden sein: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Properties of bypass_actors

Name, type, BESCHREIBUNG
`actor_id` integer or null The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.
`actor_type` string Erforderlich The type of actor that can bypass a ruleset Kann eine der Folgenden sein: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`, `DeployKey`
`bypass_mode` string 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. Also, `pull_request` is only applicable to branch rulesets. Standard: `always` Kann eine der Folgenden sein: `always`, `pull_request`

conditions object

Parameters for a repository ruleset ref name condition

Properties of conditions

Name, type, BESCHREIBUNG

ref_name object

Properties of ref_name

Name, type, BESCHREIBUNG
`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.

Can be one of these objects:

Name, type, BESCHREIBUNG

creation object Erforderlich

Only allow users with bypass permission to create matching refs.

Properties of creation

Name, type, BESCHREIBUNG
`type` string Erforderlich Wert: `creation`

update object Erforderlich

Only allow users with bypass permission to update matching refs.

Properties of update

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: update

parameters object

Properties of parameters

Name, type, BESCHREIBUNG
`update_allows_fetch_and_merge` boolean Erforderlich Branch can pull changes from its upstream repository

deletion object Erforderlich

Only allow users with bypass permissions to delete matching refs.

Properties of deletion

Name, type, BESCHREIBUNG
`type` string Erforderlich Wert: `deletion`

required_linear_history object Erforderlich

Prevent merge commits from being pushed to matching refs.

Properties of required_linear_history

Name, type, BESCHREIBUNG
`type` string Erforderlich Wert: `required_linear_history`

merge_queue object Erforderlich

Merges must be performed via a merge queue.

Properties of merge_queue

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: merge_queue

parameters object

Properties of parameters

Name, type, BESCHREIBUNG
`check_response_timeout_minutes` integer Erforderlich Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
`grouping_strategy` string Erforderlich When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. Kann eine der Folgenden sein: `ALLGREEN`, `HEADGREEN`
`max_entries_to_build` integer Erforderlich Limit the number of queued pull requests requesting checks and workflow runs at the same time.
`max_entries_to_merge` integer Erforderlich The maximum number of PRs that will be merged together in a group.
`merge_method` string Erforderlich Method to use when merging changes from queued pull requests. Kann eine der Folgenden sein: `MERGE`, `SQUASH`, `REBASE`
`min_entries_to_merge` integer Erforderlich The minimum number of PRs that will be merged together in a group.
`min_entries_to_merge_wait_minutes` integer Erforderlich The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.

required_deployments object Erforderlich

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

Properties of required_deployments

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: required_deployments

parameters object

Properties of parameters

Name, type, BESCHREIBUNG
`required_deployment_environments` array of strings Erforderlich The environments that must be successfully deployed to before branches can be merged.

required_signatures object Erforderlich

Commits pushed to matching refs must have verified signatures.

Properties of required_signatures

Name, type, BESCHREIBUNG
`type` string Erforderlich Wert: `required_signatures`

pull_request object Erforderlich

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

Properties of pull_request

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: pull_request

parameters object

Properties of parameters

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

required_status_checks object Erforderlich

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.

Properties of required_status_checks

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: required_status_checks

parameters object

Properties of parameters

Name, type, BESCHREIBUNG

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 Erforderlich

Status checks that are required.

Properties of required_status_checks

Name, type, BESCHREIBUNG
`context` string Erforderlich 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 Erforderlich

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 Erforderlich

Prevent users with push access from force pushing to refs.

Properties of non_fast_forward

Name, type, BESCHREIBUNG
`type` string Erforderlich Wert: `non_fast_forward`

commit_message_pattern object Erforderlich

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: commit_message_pattern

parameters object

Properties of parameters

Name, type, BESCHREIBUNG
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Erforderlich The operator to use for matching. Kann eine der Folgenden sein: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Erforderlich The pattern to match with.

commit_author_email_pattern object Erforderlich

Parameters to be used for the commit_author_email_pattern rule

Properties of commit_author_email_pattern

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: commit_author_email_pattern

parameters object

Properties of parameters

Name, type, BESCHREIBUNG
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Erforderlich The operator to use for matching. Kann eine der Folgenden sein: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Erforderlich The pattern to match with.

committer_email_pattern object Erforderlich

Parameters to be used for the committer_email_pattern rule

Properties of committer_email_pattern

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: committer_email_pattern

parameters object

Properties of parameters

Name, type, BESCHREIBUNG
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Erforderlich The operator to use for matching. Kann eine der Folgenden sein: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Erforderlich The pattern to match with.

branch_name_pattern object Erforderlich

Parameters to be used for the branch_name_pattern rule

Properties of branch_name_pattern

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: branch_name_pattern

parameters object

Properties of parameters

Name, type, BESCHREIBUNG
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Erforderlich The operator to use for matching. Kann eine der Folgenden sein: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Erforderlich The pattern to match with.

tag_name_pattern object Erforderlich

Parameters to be used for the tag_name_pattern rule

Properties of tag_name_pattern

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: tag_name_pattern

parameters object

Properties of parameters

Name, type, BESCHREIBUNG
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Erforderlich The operator to use for matching. Kann eine der Folgenden sein: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Erforderlich The pattern to match with.

workflows object Erforderlich

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

Properties of workflows

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: workflows

parameters object

Properties of parameters

Name, type, BESCHREIBUNG

do_not_enforce_on_create boolean

Allow repositories and branches to be created if a check would otherwise prohibit it.

workflows array of objects Erforderlich

Workflows that must pass for this rule to pass.

Properties of workflows

Name, type, BESCHREIBUNG
`path` string Erforderlich The path to the workflow file
`ref` string The ref (branch or tag) of the workflow file to use
`repository_id` integer Erforderlich The ID of the repository where the workflow is defined
`sha` string The commit SHA of the workflow file to use

code_scanning object Erforderlich

Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.

Properties of code_scanning

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: code_scanning

parameters object

Properties of parameters

Name, type, BESCHREIBUNG

code_scanning_tools array of objects Erforderlich

Tools that must provide code scanning results for this rule to pass.

Properties of code_scanning_tools

Name, type, BESCHREIBUNG
`alerts_threshold` string Erforderlich The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts." Kann eine der Folgenden sein: `none`, `errors`, `errors_and_warnings`, `all`
`security_alerts_threshold` string Erforderlich The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts." Kann eine der Folgenden sein: `none`, `critical`, `high_or_higher`, `medium_or_higher`, `all`
`tool` string Erforderlich The name of a code scanning tool

HTTP-Antwortstatuscodes für „Create a repository ruleset“

Statuscode	BESCHREIBUNG
`201`	Created
`404`	Resource not found
`500`	Internal Error

Codebeispiele für „Create a repository ruleset“

Anforderungsbeispiel

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.

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.

Differenzierte Zugriffstoken für "Get a repository ruleset"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Metadata" repository permissions (read)

Dieser Endpunkt kann ohne Authentifizierung oder die zuvor erwähnten Berechtigungen verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.

Parameter für „Get a repository ruleset“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.
`ruleset_id` integer Erforderlich The ID of the ruleset.

Abfrageparameter
Name, type, BESCHREIBUNG
`includes_parents` boolean Include rulesets configured at higher levels that apply to this repository Standard: `true`

HTTP-Antwortstatuscodes für „Get a repository ruleset“

Statuscode	BESCHREIBUNG
`200`	OK
`404`	Resource not found
`500`	Internal Error

Codebeispiele für „Get a repository ruleset“

Anforderungsbeispiel

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.

Differenzierte Zugriffstoken für "Update a repository ruleset"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Administration" repository permissions (write)

Parameter für „Update a repository ruleset“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.
`ruleset_id` integer Erforderlich The ID of the ruleset.

Name, type, BESCHREIBUNG

name string

The name of the ruleset.

target string

The target of the ruleset

Kann eine der Folgenden sein: branch, tag, push

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.

Kann eine der Folgenden sein: disabled, active, evaluate

bypass_actors array of objects

The actors that can bypass the rules in this ruleset

Properties of bypass_actors

Name, type, BESCHREIBUNG
`actor_id` integer or null The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.
`actor_type` string Erforderlich The type of actor that can bypass a ruleset Kann eine der Folgenden sein: `Integration`, `OrganizationAdmin`, `RepositoryRole`, `Team`, `DeployKey`
`bypass_mode` string 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. Also, `pull_request` is only applicable to branch rulesets. Standard: `always` Kann eine der Folgenden sein: `always`, `pull_request`

conditions object

Parameters for a repository ruleset ref name condition

Properties of conditions

Name, type, BESCHREIBUNG

ref_name object

Properties of ref_name

Name, type, BESCHREIBUNG
`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.

Can be one of these objects:

Name, type, BESCHREIBUNG

creation object Erforderlich

Only allow users with bypass permission to create matching refs.

Properties of creation

Name, type, BESCHREIBUNG
`type` string Erforderlich Wert: `creation`

update object Erforderlich

Only allow users with bypass permission to update matching refs.

Properties of update

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: update

parameters object

Properties of parameters

Name, type, BESCHREIBUNG
`update_allows_fetch_and_merge` boolean Erforderlich Branch can pull changes from its upstream repository

deletion object Erforderlich

Only allow users with bypass permissions to delete matching refs.

Properties of deletion

Name, type, BESCHREIBUNG
`type` string Erforderlich Wert: `deletion`

required_linear_history object Erforderlich

Prevent merge commits from being pushed to matching refs.

Properties of required_linear_history

Name, type, BESCHREIBUNG
`type` string Erforderlich Wert: `required_linear_history`

merge_queue object Erforderlich

Merges must be performed via a merge queue.

Properties of merge_queue

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: merge_queue

parameters object

Properties of parameters

Name, type, BESCHREIBUNG
`check_response_timeout_minutes` integer Erforderlich Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
`grouping_strategy` string Erforderlich When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. Kann eine der Folgenden sein: `ALLGREEN`, `HEADGREEN`
`max_entries_to_build` integer Erforderlich Limit the number of queued pull requests requesting checks and workflow runs at the same time.
`max_entries_to_merge` integer Erforderlich The maximum number of PRs that will be merged together in a group.
`merge_method` string Erforderlich Method to use when merging changes from queued pull requests. Kann eine der Folgenden sein: `MERGE`, `SQUASH`, `REBASE`
`min_entries_to_merge` integer Erforderlich The minimum number of PRs that will be merged together in a group.
`min_entries_to_merge_wait_minutes` integer Erforderlich The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.

required_deployments object Erforderlich

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

Properties of required_deployments

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: required_deployments

parameters object

Properties of parameters

Name, type, BESCHREIBUNG
`required_deployment_environments` array of strings Erforderlich The environments that must be successfully deployed to before branches can be merged.

required_signatures object Erforderlich

Commits pushed to matching refs must have verified signatures.

Properties of required_signatures

Name, type, BESCHREIBUNG
`type` string Erforderlich Wert: `required_signatures`

pull_request object Erforderlich

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

Properties of pull_request

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: pull_request

parameters object

Properties of parameters

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

required_status_checks object Erforderlich

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.

Properties of required_status_checks

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: required_status_checks

parameters object

Properties of parameters

Name, type, BESCHREIBUNG

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 Erforderlich

Status checks that are required.

Properties of required_status_checks

Name, type, BESCHREIBUNG
`context` string Erforderlich 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 Erforderlich

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 Erforderlich

Prevent users with push access from force pushing to refs.

Properties of non_fast_forward

Name, type, BESCHREIBUNG
`type` string Erforderlich Wert: `non_fast_forward`

commit_message_pattern object Erforderlich

Parameters to be used for the commit_message_pattern rule

Properties of commit_message_pattern

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: commit_message_pattern

parameters object

Properties of parameters

Name, type, BESCHREIBUNG
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Erforderlich The operator to use for matching. Kann eine der Folgenden sein: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Erforderlich The pattern to match with.

commit_author_email_pattern object Erforderlich

Parameters to be used for the commit_author_email_pattern rule

Properties of commit_author_email_pattern

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: commit_author_email_pattern

parameters object

Properties of parameters

Name, type, BESCHREIBUNG
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Erforderlich The operator to use for matching. Kann eine der Folgenden sein: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Erforderlich The pattern to match with.

committer_email_pattern object Erforderlich

Parameters to be used for the committer_email_pattern rule

Properties of committer_email_pattern

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: committer_email_pattern

parameters object

Properties of parameters

Name, type, BESCHREIBUNG
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Erforderlich The operator to use for matching. Kann eine der Folgenden sein: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Erforderlich The pattern to match with.

branch_name_pattern object Erforderlich

Parameters to be used for the branch_name_pattern rule

Properties of branch_name_pattern

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: branch_name_pattern

parameters object

Properties of parameters

Name, type, BESCHREIBUNG
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Erforderlich The operator to use for matching. Kann eine der Folgenden sein: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Erforderlich The pattern to match with.

tag_name_pattern object Erforderlich

Parameters to be used for the tag_name_pattern rule

Properties of tag_name_pattern

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: tag_name_pattern

parameters object

Properties of parameters

Name, type, BESCHREIBUNG
`name` string How this rule will appear to users.
`negate` boolean If true, the rule will fail if the pattern matches.
`operator` string Erforderlich The operator to use for matching. Kann eine der Folgenden sein: `starts_with`, `ends_with`, `contains`, `regex`
`pattern` string Erforderlich The pattern to match with.

workflows object Erforderlich

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

Properties of workflows

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: workflows

parameters object

Properties of parameters

Name, type, BESCHREIBUNG

do_not_enforce_on_create boolean

Allow repositories and branches to be created if a check would otherwise prohibit it.

workflows array of objects Erforderlich

Workflows that must pass for this rule to pass.

Properties of workflows

Name, type, BESCHREIBUNG
`path` string Erforderlich The path to the workflow file
`ref` string The ref (branch or tag) of the workflow file to use
`repository_id` integer Erforderlich The ID of the repository where the workflow is defined
`sha` string The commit SHA of the workflow file to use

code_scanning object Erforderlich

Properties of code_scanning

Name, type, BESCHREIBUNG

type string Erforderlich

Wert: code_scanning

parameters object

Properties of parameters

Name, type, BESCHREIBUNG

code_scanning_tools array of objects Erforderlich

Tools that must provide code scanning results for this rule to pass.

Properties of code_scanning_tools

Name, type, BESCHREIBUNG
`alerts_threshold` string Erforderlich The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "About code scanning alerts." Kann eine der Folgenden sein: `none`, `errors`, `errors_and_warnings`, `all`
`security_alerts_threshold` string Erforderlich The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "About code scanning alerts." Kann eine der Folgenden sein: `none`, `critical`, `high_or_higher`, `medium_or_higher`, `all`
`tool` string Erforderlich The name of a code scanning tool

HTTP-Antwortstatuscodes für „Update a repository ruleset“

Statuscode	BESCHREIBUNG
`200`	OK
`404`	Resource not found
`500`	Internal Error

Codebeispiele für „Update a repository ruleset“

Anforderungsbeispiel

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.

Differenzierte Zugriffstoken für "Delete a repository ruleset"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Administration" repository permissions (write)

Parameter für „Delete a repository ruleset“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.
`ruleset_id` integer Erforderlich The ID of the ruleset.

HTTP-Antwortstatuscodes für „Delete a repository ruleset“

Statuscode	BESCHREIBUNG
`204`	No Content
`404`	Resource not found
`500`	Internal Error

Codebeispiele für „Delete a repository ruleset“

Anforderungsbeispiel

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