REST-API-Endpunkte für Regeln
Verwende die REST-API, um Regelsätze für Repositorys zu verwalten. Regelsätze steuern, wie Benutzer*innen mit ausgewählten Branches und Tags in einem Repository interagieren können.
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.:
- GitHub-App-Benutzerzugriffstoken
- Zugriffstoken für GitHub App-Installation
- Differenzierte persönliche Zugriffstoken
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“
Name, type, BESCHREIBUNG |
---|
accept string Setting to |
Name, type, BESCHREIBUNG |
---|
owner string ErforderlichThe account owner of the repository. The name is not case sensitive. |
repo string ErforderlichThe name of the repository without the |
branch string ErforderlichThe name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API. |
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: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: |
HTTP-Antwortstatuscodes für „Get rules for a branch“
Statuscode | BESCHREIBUNG |
---|---|
200 | OK |
Codebeispiele für „Get rules for a branch“
Anforderungsbeispiel
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.:
- GitHub-App-Benutzerzugriffstoken
- Zugriffstoken für GitHub App-Installation
- Differenzierte persönliche Zugriffstoken
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“
Name, type, BESCHREIBUNG |
---|
accept string Setting to |
Name, type, BESCHREIBUNG |
---|
owner string ErforderlichThe account owner of the repository. The name is not case sensitive. |
repo string ErforderlichThe name of the repository without the |
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: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: |
includes_parents boolean Include rulesets configured at higher levels that apply to this repository Standard: |
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, |
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
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.:
- GitHub-App-Benutzerzugriffstoken
- Zugriffstoken für GitHub App-Installation
- Differenzierte persönliche Zugriffstoken
Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:
- "Administration" repository permissions (write)
Parameter für „Create a repository ruleset“
Name, type, BESCHREIBUNG |
---|
accept string Setting to |
Name, type, BESCHREIBUNG |
---|
owner string ErforderlichThe account owner of the repository. The name is not case sensitive. |
repo string ErforderlichThe name of the repository without the |
Name, type, BESCHREIBUNG | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name string ErforderlichThe name of the ruleset. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target string The target of the ruleset. Standard: Kann eine der Folgenden sein: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enforcement string ErforderlichThe enforcement level of the ruleset. Kann eine der Folgenden sein: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bypass_actors array of objects The actors that can bypass the rules in this ruleset | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties of |
Name, type, BESCHREIBUNG |
---|
actor_id integer ErforderlichThe ID of the actor that can bypass a ruleset. If |
actor_type string ErforderlichThe type of actor that can bypass a ruleset Kann eine der Folgenden sein: |
bypass_mode string ErforderlichWhen the specified actor can bypass the ruleset. Standard: Kann eine der Folgenden sein: |
conditions
object Parameters for a repository ruleset ref name condition
Properties of conditions
Name, type, BESCHREIBUNG | |||
---|---|---|---|
ref_name object | |||
Properties of |
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 |
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 ErforderlichOnly allow users with bypass permission to create matching refs. | |||||||||||||
Properties of |
Name, type, BESCHREIBUNG |
---|
type string ErforderlichWert: |
update
object ErforderlichOnly allow users with bypass permission to update matching refs.
Properties of update
Name, type, BESCHREIBUNG | ||
---|---|---|
type string ErforderlichWert: | ||
parameters object | ||
Properties of |
Name, type, BESCHREIBUNG |
---|
update_allows_fetch_and_merge boolean ErforderlichBranch can pull changes from its upstream repository |
deletion
object ErforderlichOnly allow users with bypass permissions to delete matching refs.
Properties of deletion
Name, type, BESCHREIBUNG |
---|
type string ErforderlichWert: |
required_linear_history
object ErforderlichPrevent merge commits from being pushed to matching refs.
Properties of required_linear_history
Name, type, BESCHREIBUNG |
---|
type string ErforderlichWert: |
required_deployments
object ErforderlichChoose 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 ErforderlichWert: | ||
parameters object | ||
Properties of |
Name, type, BESCHREIBUNG |
---|
required_deployment_environments array of strings ErforderlichThe environments that must be successfully deployed to before branches can be merged. |
required_signatures
object ErforderlichCommits pushed to matching refs must have verified signatures.
Properties of required_signatures
Name, type, BESCHREIBUNG |
---|
type string ErforderlichWert: |
pull_request
object ErforderlichRequire 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 ErforderlichWert: | ||||||
parameters object | ||||||
Properties of |
Name, type, BESCHREIBUNG |
---|
dismiss_stale_reviews_on_push boolean ErforderlichNew, reviewable commits pushed will dismiss previous pull request review approvals. |
require_code_owner_review boolean ErforderlichRequire an approving review in pull requests that modify files that have a designated code owner. |
require_last_push_approval boolean ErforderlichWhether the most recent reviewable push must be approved by someone other than the person who pushed it. |
required_approving_review_count integer ErforderlichThe number of approving reviews that are required before a pull request can be merged. |
required_review_thread_resolution boolean ErforderlichAll conversations on code must be resolved before a pull request can be merged. |
required_status_checks
object ErforderlichChoose 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 ErforderlichWert: | ||||||||
parameters object | ||||||||
Properties of |
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 ErforderlichStatus checks that are required. | |||
Properties of |
Name, type, BESCHREIBUNG |
---|
context string ErforderlichThe 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 ErforderlichWhether 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 ErforderlichPrevent users with push access from force pushing to refs.
Properties of non_fast_forward
Name, type, BESCHREIBUNG |
---|
type string ErforderlichWert: |
commit_message_pattern
object ErforderlichParameters to be used for the commit_message_pattern rule
Properties of commit_message_pattern
Name, type, BESCHREIBUNG | |||||
---|---|---|---|---|---|
type string ErforderlichWert: | |||||
parameters object | |||||
Properties of |
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 ErforderlichThe operator to use for matching. Kann eine der Folgenden sein: |
pattern string ErforderlichThe pattern to match with. |
commit_author_email_pattern
object ErforderlichParameters to be used for the commit_author_email_pattern rule
Name, type, BESCHREIBUNG | |||||
---|---|---|---|---|---|
type string ErforderlichWert: | |||||
parameters object | |||||
Properties of |
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 ErforderlichThe operator to use for matching. Kann eine der Folgenden sein: |
pattern string ErforderlichThe pattern to match with. |
committer_email_pattern
object ErforderlichParameters to be used for the committer_email_pattern rule
Properties of committer_email_pattern
Name, type, BESCHREIBUNG | |||||
---|---|---|---|---|---|
type string ErforderlichWert: | |||||
parameters object | |||||
Properties of |
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 ErforderlichThe operator to use for matching. Kann eine der Folgenden sein: |
pattern string ErforderlichThe pattern to match with. |
branch_name_pattern
object ErforderlichParameters to be used for the branch_name_pattern rule
Properties of branch_name_pattern
Name, type, BESCHREIBUNG | |||||
---|---|---|---|---|---|
type string ErforderlichWert: | |||||
parameters object | |||||
Properties of |
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 ErforderlichThe operator to use for matching. Kann eine der Folgenden sein: |
pattern string ErforderlichThe pattern to match with. |
tag_name_pattern
object ErforderlichParameters to be used for the tag_name_pattern rule
Properties of tag_name_pattern
Name, type, BESCHREIBUNG | |||||
---|---|---|---|---|---|
type string ErforderlichWert: | |||||
parameters object | |||||
Properties of |
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 ErforderlichThe operator to use for matching. Kann eine der Folgenden sein: |
pattern string ErforderlichThe pattern to match with. |
workflows
object ErforderlichRequire 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 ErforderlichWert: | |||||||||
parameters object | |||||||||
Properties of |
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 ErforderlichWorkflows that must pass for this rule to pass. | |||||
Properties of |
Name, type, BESCHREIBUNG |
---|
path string ErforderlichThe path to the workflow file |
ref string The ref (branch or tag) of the workflow file to use |
repository_id integer ErforderlichThe ID of the repository where the workflow is defined |
sha string The commit SHA of the workflow file to use |
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
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.:
- GitHub-App-Benutzerzugriffstoken
- Zugriffstoken für GitHub App-Installation
- Differenzierte persönliche Zugriffstoken
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“
Name, type, BESCHREIBUNG |
---|
accept string Setting to |
Name, type, BESCHREIBUNG |
---|
owner string ErforderlichThe account owner of the repository. The name is not case sensitive. |
repo string ErforderlichThe name of the repository without the |
ruleset_id integer ErforderlichThe ID of the ruleset. |
Name, type, BESCHREIBUNG |
---|
includes_parents boolean Include rulesets configured at higher levels that apply to this repository Standard: |
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
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.:
- GitHub-App-Benutzerzugriffstoken
- Zugriffstoken für GitHub App-Installation
- Differenzierte persönliche Zugriffstoken
Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:
- "Administration" repository permissions (write)
Parameter für „Update a repository ruleset“
Name, type, BESCHREIBUNG |
---|
accept string Setting to |
Name, type, BESCHREIBUNG |
---|
owner string ErforderlichThe account owner of the repository. The name is not case sensitive. |
repo string ErforderlichThe name of the repository without the |
ruleset_id integer ErforderlichThe 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: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enforcement string The enforcement level of the ruleset. Kann eine der Folgenden sein: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bypass_actors array of objects The actors that can bypass the rules in this ruleset | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties of |
Name, type, BESCHREIBUNG |
---|
actor_id integer ErforderlichThe ID of the actor that can bypass a ruleset. If |
actor_type string ErforderlichThe type of actor that can bypass a ruleset Kann eine der Folgenden sein: |
bypass_mode string ErforderlichWhen the specified actor can bypass the ruleset. Standard: Kann eine der Folgenden sein: |
conditions
object Parameters for a repository ruleset ref name condition
Properties of conditions
Name, type, BESCHREIBUNG | |||
---|---|---|---|
ref_name object | |||
Properties of |
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 |
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 ErforderlichOnly allow users with bypass permission to create matching refs. | |||||||||||||
Properties of |
Name, type, BESCHREIBUNG |
---|
type string ErforderlichWert: |
update
object ErforderlichOnly allow users with bypass permission to update matching refs.
Properties of update
Name, type, BESCHREIBUNG | ||
---|---|---|
type string ErforderlichWert: | ||
parameters object | ||
Properties of |
Name, type, BESCHREIBUNG |
---|
update_allows_fetch_and_merge boolean ErforderlichBranch can pull changes from its upstream repository |
deletion
object ErforderlichOnly allow users with bypass permissions to delete matching refs.
Properties of deletion
Name, type, BESCHREIBUNG |
---|
type string ErforderlichWert: |
required_linear_history
object ErforderlichPrevent merge commits from being pushed to matching refs.
Properties of required_linear_history
Name, type, BESCHREIBUNG |
---|
type string ErforderlichWert: |
required_deployments
object ErforderlichChoose 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 ErforderlichWert: | ||
parameters object | ||
Properties of |
Name, type, BESCHREIBUNG |
---|
required_deployment_environments array of strings ErforderlichThe environments that must be successfully deployed to before branches can be merged. |
required_signatures
object ErforderlichCommits pushed to matching refs must have verified signatures.
Properties of required_signatures
Name, type, BESCHREIBUNG |
---|
type string ErforderlichWert: |
pull_request
object ErforderlichRequire 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 ErforderlichWert: | ||||||
parameters object | ||||||
Properties of |
Name, type, BESCHREIBUNG |
---|
dismiss_stale_reviews_on_push boolean ErforderlichNew, reviewable commits pushed will dismiss previous pull request review approvals. |
require_code_owner_review boolean ErforderlichRequire an approving review in pull requests that modify files that have a designated code owner. |
require_last_push_approval boolean ErforderlichWhether the most recent reviewable push must be approved by someone other than the person who pushed it. |
required_approving_review_count integer ErforderlichThe number of approving reviews that are required before a pull request can be merged. |
required_review_thread_resolution boolean ErforderlichAll conversations on code must be resolved before a pull request can be merged. |
required_status_checks
object ErforderlichChoose 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 ErforderlichWert: | ||||||||
parameters object | ||||||||
Properties of |
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 ErforderlichStatus checks that are required. | |||
Properties of |
Name, type, BESCHREIBUNG |
---|
context string ErforderlichThe 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 ErforderlichWhether 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 ErforderlichPrevent users with push access from force pushing to refs.
Properties of non_fast_forward
Name, type, BESCHREIBUNG |
---|
type string ErforderlichWert: |
commit_message_pattern
object ErforderlichParameters to be used for the commit_message_pattern rule
Properties of commit_message_pattern
Name, type, BESCHREIBUNG | |||||
---|---|---|---|---|---|
type string ErforderlichWert: | |||||
parameters object | |||||
Properties of |
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 ErforderlichThe operator to use for matching. Kann eine der Folgenden sein: |
pattern string ErforderlichThe pattern to match with. |
commit_author_email_pattern
object ErforderlichParameters to be used for the commit_author_email_pattern rule
Name, type, BESCHREIBUNG | |||||
---|---|---|---|---|---|
type string ErforderlichWert: | |||||
parameters object | |||||
Properties of |
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 ErforderlichThe operator to use for matching. Kann eine der Folgenden sein: |
pattern string ErforderlichThe pattern to match with. |
committer_email_pattern
object ErforderlichParameters to be used for the committer_email_pattern rule
Properties of committer_email_pattern
Name, type, BESCHREIBUNG | |||||
---|---|---|---|---|---|
type string ErforderlichWert: | |||||
parameters object | |||||
Properties of |
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 ErforderlichThe operator to use for matching. Kann eine der Folgenden sein: |
pattern string ErforderlichThe pattern to match with. |
branch_name_pattern
object ErforderlichParameters to be used for the branch_name_pattern rule
Properties of branch_name_pattern
Name, type, BESCHREIBUNG | |||||
---|---|---|---|---|---|
type string ErforderlichWert: | |||||
parameters object | |||||
Properties of |
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 ErforderlichThe operator to use for matching. Kann eine der Folgenden sein: |
pattern string ErforderlichThe pattern to match with. |
tag_name_pattern
object ErforderlichParameters to be used for the tag_name_pattern rule
Properties of tag_name_pattern
Name, type, BESCHREIBUNG | |||||
---|---|---|---|---|---|
type string ErforderlichWert: | |||||
parameters object | |||||
Properties of |
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 ErforderlichThe operator to use for matching. Kann eine der Folgenden sein: |
pattern string ErforderlichThe pattern to match with. |
workflows
object ErforderlichRequire 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 ErforderlichWert: | |||||||||
parameters object | |||||||||
Properties of |
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 ErforderlichWorkflows that must pass for this rule to pass. | |||||
Properties of |
Name, type, BESCHREIBUNG |
---|
path string ErforderlichThe path to the workflow file |
ref string The ref (branch or tag) of the workflow file to use |
repository_id integer ErforderlichThe ID of the repository where the workflow is defined |
sha string The commit SHA of the workflow file to use |
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
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.:
- GitHub-App-Benutzerzugriffstoken
- Zugriffstoken für GitHub App-Installation
- Differenzierte persönliche Zugriffstoken
Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:
- "Administration" repository permissions (write)
Parameter für „Delete a repository ruleset“
Name, type, BESCHREIBUNG |
---|
accept string Setting to |
Name, type, BESCHREIBUNG |
---|
owner string ErforderlichThe account owner of the repository. The name is not case sensitive. |
repo string ErforderlichThe name of the repository without the |
ruleset_id integer ErforderlichThe 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
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