Update repository preferences for check suites

Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.

curl --location --request PATCH 'https://api.github.com/repos///check-suites/preferences' \ --header 'Content-Type: application/json' \ --data-raw '{ "auto_trigger_checks": [ { "app_id": 4, "setting": false } ] }'

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

Body 参数application/json

auto_trigger_checks

array [object {2}]

可选

Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

app_id

integer

必需

The id of the GitHub App.

setting

boolean

必需

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

默认值:

true

示例

返回响应

🟢200Response

application/json

Body

Check suite configuration preferences for a repository.

preferences

object

必需

auto_trigger_checks

array [object {2}]

可选

repository

object (Minimal Repository)

必需

Minimal Repository

archive_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}

archived

boolean

可选

assignees_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/assignees{/user}

blobs_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}

branches_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/branches{/branch}

clone_url

string

可选

collaborators_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}

comments_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/comments{/number}

commits_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/commits{/sha}

compare_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}

contents_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/contents/{+path}

contributors_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/contributors

created_at

string <date-time> | null

可选

示例值:

2011-01-26T19:01:12Z

default_branch

string

可选

delete_branch_on_merge

boolean

可选

deployments_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/deployments

description

string | null

必需

示例值:

This your first repo!

disabled

boolean

可选

downloads_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/downloads

events_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/events

fork

boolean

必需

forks

integer

可选

示例值:

forks_count

integer

可选

forks_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/forks

full_name

string

必需

示例值:

octocat/Hello-World

git_commits_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}

git_refs_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}

git_tags_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}

git_url

string

可选

has_downloads

boolean

可选

has_issues

boolean

可选

has_pages

boolean

可选

has_projects

boolean

可选

has_wiki

boolean

可选

homepage

string | null

可选

hooks_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/hooks

html_url

string <uri>

必需

示例值:

https://github.com/octocat/Hello-World

integer

必需

示例值:

1296269

is_template

boolean

可选

issue_comment_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}

issue_events_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues/events{/number}

issues_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues{/number}

keys_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/keys{/key_id}

labels_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/labels{/name}

language

string | null

可选

languages_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/languages

license

object | null

可选

merges_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/merges

milestones_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/milestones{/number}

mirror_url

string | null

可选

name

string

必需

示例值:

Hello-World

network_count

integer

可选

node_id

string

必需

示例值:

MDEwOlJlcG9zaXRvcnkxMjk2MjY5

notifications_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}

open_issues

integer

可选

示例值:

open_issues_count

integer

可选

owner

object | null | allOf {1}

必需

permissions

object

可选

private

boolean

必需

pulls_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/pulls{/number}

pushed_at

string <date-time> | null

可选

示例值:

2011-01-26T19:06:43Z

releases_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/releases{/id}

size

integer

可选

ssh_url

string

可选

stargazers_count

integer

可选

stargazers_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/stargazers

statuses_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/statuses/{sha}

subscribers_count

integer

可选

subscribers_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/subscribers

subscription_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/subscription

svn_url

string

可选

tags_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/tags

teams_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/teams

temp_clone_token

string

可选

template_repository

object | null | allOf {1}

可选

topics

array[string]

可选

trees_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}

updated_at

string <date-time> | null

可选

示例值:

2011-01-26T19:14:43Z

url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/Hello-World

visibility

string

可选

watchers

integer

可选

示例值:

watchers_count

integer

可选