创建自动化检查
创建自动化检查
Path Parameters
- owner required
代码仓库的所有者,一般称之为"用户名(username)"。该名称不区分大小写。
- repo required
代码仓库名称。该名称不区分大小写。
Header Parameters
- Authorization required
应用ats token(需以Bearer加空格开头)
- application/json
Request Body
- name string
自动化检查的名称. 例如, "code-coverage"。
- head_sha string
提交 SHA 值
- status string
状态枚举,枚举值为:queued, in_progress, completed。默认值: queued
- started_at string
检查开始时间。 遵循 ISO 8601 时间格式: YYYY-MM-DDTHH:MM:SSZ
- conclusion string
如果您传递了 "completed_at" 字段或将 "status" 字段设置为 "completed",则该字段为必传。该字段表达自动化检查的最终结果。、 注:提供 "conclusion" 字段将自动设置状态参数为 "completed"。同时将不能将 "conclusion" 更改为 "stale",只有平台可以设置为此值。 枚举值: action_required, cancelled, failure, neutral, success, skip, stale, timed_out
- completed_at string
检查结束时间。 遵循 ISO 8601 时间格式: YYYY-MM-DDTHH:MM:SSZ
action object
自动化检查可以接受 "output" 中的各类数据,包括标题和摘要,并且可以选择性地提供有关运行的描述性详细信息。
label string在web UI的按钮上显示的文本。最大长度为 20 个字符。
description string关于 action 用途的简短解释。最大长度为 40 个字符。
identifier string集成系统上对于 action 的一个对照标识。最大长度为 20 字符.
output object
自动化检查可以接受 "output" 中的各类数据,包括标题和摘要,并且可以选择性地提供有关运行的描述性详细信息。
title string标题
summary string摘要,支持Markdown格式. 最大长度为 65535 字符。
text string详情,最大长度为 65535 字符。
annotations object
将您分析出的信息附加到特定的代码行。 后续在平台上的更改请求的检查和文件更改选项卡中可以看到对应注释(annotations)。 自动化检查的 API 将请求的注释数量限制为最多 50 个。 如果要创建多于 50 个,可以多次发送请求, 从而将注释添加到已存在的注释列表中。
path string要添加注释的文件的路径。例如:assets/css/main.css。
start_line int注释的起始行。行号从 1 开始。
end_line int注释的结束行。
start_column int注释的开始列。注释只支持同一行上的 start_column 和 end_column。如果 start_line 和 end_line 的值不同,则省略此参数。列号从 1 开始。
end_column int注释的结束列。注释只支持同一行上的start_column和end_column。如果start_line和end_line的值不同,则省略此参数。
annotation_level string注释的级别, 枚举值为:notice, warning, failure
message string代码行信息的简短描述。最大为 64kb。
title string注释的标题。最大长度为 255 个字符。
raw_details string注释的详细信息。最大为 64kb。
images object
在CR UI中添加图像。
alt string图像的替代文本。
image_url string图像的完整URL。
caption string简短的图像描述。
- 201
- 500
- responseBody
已创建
内部错误
- application/json
- Schema
Schema
- id integer
- head_sha string
- external_id integer
- status string
- conclusion string
- started_at string
检查开始时间。 遵循 ISO 8601 时间格式: YYYY-MM-DDTHH:MM:SSZ
- completed_at string
检查结束时间。 遵循 ISO 8601 时间格式: YYYY-MM-DDTHH:MM:SSZ
- name string
app object
id integerslug stringname stringdescription string