Points de terminaison d’API REST pour les règles
Utilisez l’API REST pour gérer les ensembles de règles pour les référentiels. Les ensembles de règles contrôlent la façon dont les utilisateurs peuvent interagir avec les branches et les étiquettes sélectionnées dans un dépôt.
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.
Jetons d’accès affinés pour « Get rules for a branch »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis doit avoir l’ensemble d’autorisations suivant:
- "Metadata" repository permissions (read)
Ce point de terminaison peut être utilisé sans authentification ou sans les autorisations mentionnées ci-dessus si seules les ressources publiques sont demandées.
Paramètres pour « Get rules for a branch »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
owner string ObligatoireThe account owner of the repository. The name is not case sensitive. |
repo string ObligatoireThe name of the repository without the |
branch string ObligatoireThe name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API. |
Nom, Type, Description |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: |
Codes d’état de la réponse HTTP pour « Get rules for a branch »
Code d’état | Description |
---|---|
200 | OK |
Exemples de code pour « Get rules for a branch »
Exemple de requête
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.
Jetons d’accès affinés pour « Get all repository rulesets »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis doit avoir l’ensemble d’autorisations suivant:
- "Metadata" repository permissions (read)
Ce point de terminaison peut être utilisé sans authentification ou sans les autorisations mentionnées ci-dessus si seules les ressources publiques sont demandées.
Paramètres pour « Get all repository rulesets »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
owner string ObligatoireThe account owner of the repository. The name is not case sensitive. |
repo string ObligatoireThe name of the repository without the |
Nom, Type, Description |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: |
includes_parents boolean Include rulesets configured at higher levels that apply to this repository Default: |
Codes d’état de la réponse HTTP pour « Get all repository rulesets »
Code d’état | Description |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
Exemples de code pour « Get all repository rulesets »
Exemple de requête
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.
Jetons d’accès affinés pour « Create a repository ruleset »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis doit avoir l’ensemble d’autorisations suivant:
- "Administration" repository permissions (write)
Paramètres pour « Create a repository ruleset »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
owner string ObligatoireThe account owner of the repository. The name is not case sensitive. |
repo string ObligatoireThe name of the repository without the |
Nom, Type, Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name string ObligatoireThe name of the ruleset. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target string The target of the ruleset Default: Peut être: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enforcement string ObligatoireThe enforcement level of the ruleset. Peut être: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bypass_actors array of objects The actors that can bypass the rules in this ruleset | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties of |
Nom, Type, Description |
---|
actor_id integer ObligatoireThe ID of the actor that can bypass a ruleset. If |
actor_type string ObligatoireThe type of actor that can bypass a ruleset Peut être: |
bypass_mode string ObligatoireWhen the specified actor can bypass the ruleset. Default: Peut être: |
conditions
object Parameters for a repository ruleset ref name condition
Properties of conditions
Nom, Type, Description | |||
---|---|---|---|
ref_name object | |||
Properties of |
Nom, Type, Description |
---|
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:
Nom, Type, Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
creation object ObligatoireOnly allow users with bypass permission to create matching refs. | |||||||||||||
Properties of |
Nom, Type, Description |
---|
type string ObligatoireValue: |
update
object ObligatoireOnly allow users with bypass permission to update matching refs.
Properties of update
Nom, Type, Description | ||
---|---|---|
type string ObligatoireValue: | ||
parameters object | ||
Properties of |
Nom, Type, Description |
---|
update_allows_fetch_and_merge boolean ObligatoireBranch can pull changes from its upstream repository |
deletion
object ObligatoireOnly allow users with bypass permissions to delete matching refs.
Properties of deletion
Nom, Type, Description |
---|
type string ObligatoireValue: |
required_linear_history
object ObligatoirePrevent merge commits from being pushed to matching refs.
Properties of required_linear_history
Nom, Type, Description |
---|
type string ObligatoireValue: |
required_deployments
object ObligatoireChoose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
Properties of required_deployments
Nom, Type, Description | ||
---|---|---|
type string ObligatoireValue: | ||
parameters object | ||
Properties of |
Nom, Type, Description |
---|
required_deployment_environments array of strings ObligatoireThe environments that must be successfully deployed to before branches can be merged. |
required_signatures
object ObligatoireCommits pushed to matching refs must have verified signatures.
Properties of required_signatures
Nom, Type, Description |
---|
type string ObligatoireValue: |
pull_request
object ObligatoireRequire all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Properties of pull_request
Nom, Type, Description | ||||||
---|---|---|---|---|---|---|
type string ObligatoireValue: | ||||||
parameters object | ||||||
Properties of |
Nom, Type, Description |
---|
dismiss_stale_reviews_on_push boolean ObligatoireNew, reviewable commits pushed will dismiss previous pull request review approvals. |
require_code_owner_review boolean ObligatoireRequire an approving review in pull requests that modify files that have a designated code owner. |
require_last_push_approval boolean ObligatoireWhether the most recent reviewable push must be approved by someone other than the person who pushed it. |
required_approving_review_count integer ObligatoireThe number of approving reviews that are required before a pull request can be merged. |
required_review_thread_resolution boolean ObligatoireAll conversations on code must be resolved before a pull request can be merged. |
required_status_checks
object ObligatoireChoose 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
Nom, Type, Description | ||||||||
---|---|---|---|---|---|---|---|---|
type string ObligatoireValue: | ||||||||
parameters object | ||||||||
Properties of |
Nom, Type, Description | |||
---|---|---|---|
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 ObligatoireStatus checks that are required. | |||
Properties of |
Nom, Type, Description |
---|
context string ObligatoireThe 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 ObligatoireWhether 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 ObligatoirePrevent users with push access from force pushing to refs.
Properties of non_fast_forward
Nom, Type, Description |
---|
type string ObligatoireValue: |
commit_message_pattern
object ObligatoireParameters to be used for the commit_message_pattern rule
Properties of commit_message_pattern
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
commit_author_email_pattern
object ObligatoireParameters to be used for the commit_author_email_pattern rule
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
committer_email_pattern
object ObligatoireParameters to be used for the committer_email_pattern rule
Properties of committer_email_pattern
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
branch_name_pattern
object ObligatoireParameters to be used for the branch_name_pattern rule
Properties of branch_name_pattern
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
tag_name_pattern
object ObligatoireParameters to be used for the tag_name_pattern rule
Properties of tag_name_pattern
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
workflows
object ObligatoireRequire all changes made to a targeted branch to pass the specified workflows before they can be merged.
Properties of workflows
Nom, Type, Description | |||||||||
---|---|---|---|---|---|---|---|---|---|
type string ObligatoireValue: | |||||||||
parameters object | |||||||||
Properties of |
Nom, Type, Description | |||||
---|---|---|---|---|---|
do_not_enforce_on_create boolean Allow repositories and branches to be created if a check would otherwise prohibit it. | |||||
workflows array of objects ObligatoireWorkflows that must pass for this rule to pass. | |||||
Properties of |
Nom, Type, Description |
---|
path string ObligatoireThe path to the workflow file |
ref string The ref (branch or tag) of the workflow file to use |
repository_id integer ObligatoireThe ID of the repository where the workflow is defined |
sha string The commit SHA of the workflow file to use |
Codes d’état de la réponse HTTP pour « Create a repository ruleset »
Code d’état | Description |
---|---|
201 | Created |
404 | Resource not found |
500 | Internal Error |
Exemples de code pour « Create a repository ruleset »
Exemple de requête
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.
Jetons d’accès affinés pour « Get a repository ruleset »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis doit avoir l’ensemble d’autorisations suivant:
- "Metadata" repository permissions (read)
Ce point de terminaison peut être utilisé sans authentification ou sans les autorisations mentionnées ci-dessus si seules les ressources publiques sont demandées.
Paramètres pour « Get a repository ruleset »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
owner string ObligatoireThe account owner of the repository. The name is not case sensitive. |
repo string ObligatoireThe name of the repository without the |
ruleset_id integer ObligatoireThe ID of the ruleset. |
Nom, Type, Description |
---|
includes_parents boolean Include rulesets configured at higher levels that apply to this repository Default: |
Codes d’état de la réponse HTTP pour « Get a repository ruleset »
Code d’état | Description |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
Exemples de code pour « Get a repository ruleset »
Exemple de requête
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.
Jetons d’accès affinés pour « Update a repository ruleset »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis doit avoir l’ensemble d’autorisations suivant:
- "Administration" repository permissions (write)
Paramètres pour « Update a repository ruleset »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
owner string ObligatoireThe account owner of the repository. The name is not case sensitive. |
repo string ObligatoireThe name of the repository without the |
ruleset_id integer ObligatoireThe ID of the ruleset. |
Nom, Type, Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name string The name of the ruleset. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target string The target of the ruleset Peut être: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enforcement string The enforcement level of the ruleset. Peut être: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bypass_actors array of objects The actors that can bypass the rules in this ruleset | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties of |
Nom, Type, Description |
---|
actor_id integer ObligatoireThe ID of the actor that can bypass a ruleset. If |
actor_type string ObligatoireThe type of actor that can bypass a ruleset Peut être: |
bypass_mode string ObligatoireWhen the specified actor can bypass the ruleset. Default: Peut être: |
conditions
object Parameters for a repository ruleset ref name condition
Properties of conditions
Nom, Type, Description | |||
---|---|---|---|
ref_name object | |||
Properties of |
Nom, Type, Description |
---|
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:
Nom, Type, Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
creation object ObligatoireOnly allow users with bypass permission to create matching refs. | |||||||||||||
Properties of |
Nom, Type, Description |
---|
type string ObligatoireValue: |
update
object ObligatoireOnly allow users with bypass permission to update matching refs.
Properties of update
Nom, Type, Description | ||
---|---|---|
type string ObligatoireValue: | ||
parameters object | ||
Properties of |
Nom, Type, Description |
---|
update_allows_fetch_and_merge boolean ObligatoireBranch can pull changes from its upstream repository |
deletion
object ObligatoireOnly allow users with bypass permissions to delete matching refs.
Properties of deletion
Nom, Type, Description |
---|
type string ObligatoireValue: |
required_linear_history
object ObligatoirePrevent merge commits from being pushed to matching refs.
Properties of required_linear_history
Nom, Type, Description |
---|
type string ObligatoireValue: |
required_deployments
object ObligatoireChoose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
Properties of required_deployments
Nom, Type, Description | ||
---|---|---|
type string ObligatoireValue: | ||
parameters object | ||
Properties of |
Nom, Type, Description |
---|
required_deployment_environments array of strings ObligatoireThe environments that must be successfully deployed to before branches can be merged. |
required_signatures
object ObligatoireCommits pushed to matching refs must have verified signatures.
Properties of required_signatures
Nom, Type, Description |
---|
type string ObligatoireValue: |
pull_request
object ObligatoireRequire all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Properties of pull_request
Nom, Type, Description | ||||||
---|---|---|---|---|---|---|
type string ObligatoireValue: | ||||||
parameters object | ||||||
Properties of |
Nom, Type, Description |
---|
dismiss_stale_reviews_on_push boolean ObligatoireNew, reviewable commits pushed will dismiss previous pull request review approvals. |
require_code_owner_review boolean ObligatoireRequire an approving review in pull requests that modify files that have a designated code owner. |
require_last_push_approval boolean ObligatoireWhether the most recent reviewable push must be approved by someone other than the person who pushed it. |
required_approving_review_count integer ObligatoireThe number of approving reviews that are required before a pull request can be merged. |
required_review_thread_resolution boolean ObligatoireAll conversations on code must be resolved before a pull request can be merged. |
required_status_checks
object ObligatoireChoose 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
Nom, Type, Description | ||||||||
---|---|---|---|---|---|---|---|---|
type string ObligatoireValue: | ||||||||
parameters object | ||||||||
Properties of |
Nom, Type, Description | |||
---|---|---|---|
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 ObligatoireStatus checks that are required. | |||
Properties of |
Nom, Type, Description |
---|
context string ObligatoireThe 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 ObligatoireWhether 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 ObligatoirePrevent users with push access from force pushing to refs.
Properties of non_fast_forward
Nom, Type, Description |
---|
type string ObligatoireValue: |
commit_message_pattern
object ObligatoireParameters to be used for the commit_message_pattern rule
Properties of commit_message_pattern
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
commit_author_email_pattern
object ObligatoireParameters to be used for the commit_author_email_pattern rule
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
committer_email_pattern
object ObligatoireParameters to be used for the committer_email_pattern rule
Properties of committer_email_pattern
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
branch_name_pattern
object ObligatoireParameters to be used for the branch_name_pattern rule
Properties of branch_name_pattern
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
tag_name_pattern
object ObligatoireParameters to be used for the tag_name_pattern rule
Properties of tag_name_pattern
Nom, Type, Description | |||||
---|---|---|---|---|---|
type string ObligatoireValue: | |||||
parameters object | |||||
Properties of |
Nom, Type, Description |
---|
name string How this rule will appear to users. |
negate boolean If true, the rule will fail if the pattern matches. |
operator string ObligatoireThe operator to use for matching. Peut être: |
pattern string ObligatoireThe pattern to match with. |
workflows
object ObligatoireRequire all changes made to a targeted branch to pass the specified workflows before they can be merged.
Properties of workflows
Nom, Type, Description | |||||||||
---|---|---|---|---|---|---|---|---|---|
type string ObligatoireValue: | |||||||||
parameters object | |||||||||
Properties of |
Nom, Type, Description | |||||
---|---|---|---|---|---|
do_not_enforce_on_create boolean Allow repositories and branches to be created if a check would otherwise prohibit it. | |||||
workflows array of objects ObligatoireWorkflows that must pass for this rule to pass. | |||||
Properties of |
Nom, Type, Description |
---|
path string ObligatoireThe path to the workflow file |
ref string The ref (branch or tag) of the workflow file to use |
repository_id integer ObligatoireThe ID of the repository where the workflow is defined |
sha string The commit SHA of the workflow file to use |
Codes d’état de la réponse HTTP pour « Update a repository ruleset »
Code d’état | Description |
---|---|
200 | OK |
404 | Resource not found |
500 | Internal Error |
Exemples de code pour « Update a repository ruleset »
Exemple de requête
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.
Jetons d’accès affinés pour « Delete a repository ruleset »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis doit avoir l’ensemble d’autorisations suivant:
- "Administration" repository permissions (write)
Paramètres pour « Delete a repository ruleset »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
owner string ObligatoireThe account owner of the repository. The name is not case sensitive. |
repo string ObligatoireThe name of the repository without the |
ruleset_id integer ObligatoireThe ID of the ruleset. |
Codes d’état de la réponse HTTP pour « Delete a repository ruleset »
Code d’état | Description |
---|---|
204 | No Content |
404 | Resource not found |
500 | Internal Error |
Exemples de code pour « Delete a repository ruleset »
Exemple de requête
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