构建
单个构建。
属性
最小表示
当资源作为另一个资源的一部分返回时包含。
| 名称 | 类型 | 描述 |
|---|---|---|
| id | 整数 | 唯一标识构建的值。 |
| number | 字符串 | 存储库构建的增量编号。 |
| state | 字符串 | 构建的当前状态。 |
| duration | 整数 | 以秒为单位的挂钟时间。 |
| event_type | 字符串 | 触发构建的事件。 |
| previous_state | 字符串 | 先前构建的状态（用于查看状态是否更改）。 |
| pull_request_title | 字符串 | 构建的拉取请求的标题。 |
| pull_request_number | 整数 | 构建的拉取请求的编号。 |
| started_at | 字符串 | 构建开始的时间。 |
| finished_at | 字符串 | 构建完成的时间。 |
| private | 布尔值 | 构建是否为私有。 |
| priority | 未知 | 构建的优先级。 |
标准表示
当资源是请求的主要响应时包含，或 急切加载。
| 名称 | 类型 | 描述 |
|---|---|---|
| id | 整数 | 唯一标识构建的值。 |
| number | 字符串 | 存储库构建的增量编号。 |
| state | 字符串 | 构建的当前状态。 |
| duration | 整数 | 以秒为单位的挂钟时间。 |
| event_type | 字符串 | 触发构建的事件。 |
| previous_state | 字符串 | 先前构建的状态（用于查看状态是否更改）。 |
| pull_request_title | 字符串 | 构建的拉取请求的标题。 |
| pull_request_number | 整数 | 构建的拉取请求的编号。 |
| started_at | 字符串 | 构建开始的时间。 |
| finished_at | 字符串 | 构建完成的时间。 |
| private | 布尔值 | 构建是否为私有。 |
| priority | 未知 | 构建的优先级。 |
| repository | 存储库 | 构建所属的 GitHub 用户或组织。 |
| branch | 分支 | 构建关联的分支。 |
| tag | 字符串 | 构建的标签。 |
| commit | 提交 | 构建关联的提交。 |
| jobs | 作业 | 构建矩阵的一部分的作业列表。 |
| stages | [阶段] | 构建的阶段。 |
| created_by | 所有者 | 创建构建的用户或组织。 |
| updated_at | 字符串 | 构建最后更新的时间。 |
操作
查找
这将返回单个构建。
GET
/build/{build.id}
| 模板变量 | 类型 | 描述 |
|---|---|---|
| build.id | 整数 | 唯一标识构建的值。 |
| 查询参数 | 类型 | 描述 |
|---|---|---|
| include | [字符串] | 要 急切加载 的属性列表。 |
示例GET /build/86601346
取消
这将取消当前正在运行的构建。它将设置 build 和关联的 jobs 为 "state": "canceled"。
POST
/build/{build.id}/cancel
| 模板变量 | 类型 | 描述 |
|---|---|---|
| build.id | 整数 | 唯一标识构建的值。 |
示例POST /build/86601346/cancel
重启
这将重新启动已完成或已取消的构建。
POST
/build/{build.id}/restart
| 模板变量 | 类型 | 描述 |
|---|---|---|
| build.id | 整数 | 唯一标识构建的值。 |
示例POST /build/86601346/restart
优先级
未找到文档 resources/build/actions/priority。
POST
/build/{build.id}/priority
| 模板变量 | 类型 | 描述 |
|---|---|---|
| build.id | 整数 | 唯一标识构建的值。 |
| 接受的参数 | 类型 | 描述 |
|---|---|---|
| build.cancel_all | 未知 | 缺少文档。 |
示例POST /build/86601346/priority