构建
构建列表。
如果使用仓库标识符查询，则必须使用 标准 URL 编码 格式，包括任何特殊字符。
属性
| 名称 | 类型 | 描述 |
|---|---|---|
| builds | [构建] | 构建列表。 |
集合项
builds 数组中的每个条目都具有以下属性
| 名称 | 类型 | 描述 |
|---|---|---|
| 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 | 字符串 | 构建最后更新时间。 |
| request | 未知 | 构建的请求。 |
| log_complete | 未知 | 构建的 log_complete。 |
操作
对于当前用户
这将返回当前用户的构建列表。结果是分页的。默认限制为 100。
GET
/builds
| 查询参数 | 类型 | 描述 |
|---|---|---|
| include | [字符串] | 要 预加载 的属性列表。 |
| limit | 整数 | 响应中包含多少个构建。用于 分页。 |
| limit | 整数 | 响应中包含多少个构建。用于 分页。 |
| offset | 整数 | 响应中第一个条目之前的构建数量。用于 分页。 |
| offset | 整数 | 响应中第一个条目之前的构建数量。用于 分页。 |
| sort_by | [字符串] | 按属性对构建进行排序。用于 分页。 |
| sort_by | [字符串] | 按属性对构建进行排序。用于 分页。 |
示例GET /builds?limit=5
可排序属性id, created_at, started_at, finished_at, number, 附加:desc到任何属性以反转顺序。
默认值为number:desc,id:desc.
查找
这将返回单个仓库的构建列表。可以使用请求中的仓库 ID 或标识符。结果是分页的。每个请求将返回 25 个结果。
GET
/repo/{provider}/{repository.id}/builds
| 模板变量 | 类型 | 描述 |
|---|---|---|
| provider | 未知 | 文档缺失。 |
| repository.id | 整数 | 唯一标识仓库的值。 |
| 查询参数 | 类型 | 描述 |
|---|---|---|
| branch.name | [字符串] | 按 Git 分支的名称筛选构建。 |
| build.created_by | [所有者] | 按创建构建的用户或组织筛选构建。 |
| build.event_type | [字符串] | 按触发构建的事件筛选构建。 |
| build.previous_state | [字符串] | 按先前构建的状态筛选构建（用于查看状态是否已更改）。 |
| build.state | [字符串] | 按构建的当前状态筛选构建。 |
| created_by | [所有者] | 别名为build.created_by. |
| event_type | [字符串] | 别名为build.event_type. |
| include | [字符串] | 要 预加载 的属性列表。 |
| limit | 整数 | 响应中包含多少个构建。用于 分页。 |
| offset | 整数 | 响应中第一个条目之前的构建数量。用于 分页。 |
| previous_state | [字符串] | 别名为build.previous_state. |
| sort_by | [字符串] | 按属性对构建进行排序。用于 分页。 |
| state | [字符串] | 别名为build.state. |
可排序属性id, created_at, started_at, finished_at, number, 附加:desc到任何属性以反转顺序。
默认值为number:desc,id:desc.
GET
/repo/{provider}/{repository.slug}/builds
| 模板变量 | 类型 | 描述 |
|---|---|---|
| provider | 未知 | 文档缺失。 |
| repository.slug | 字符串 | 与 {repository.owner.name}/{repository.name} 相同。 |
| 查询参数 | 类型 | 描述 |
|---|---|---|
| branch.name | [字符串] | 按 Git 分支的名称筛选构建。 |
| build.created_by | [所有者] | 按创建构建的用户或组织筛选构建。 |
| build.event_type | [字符串] | 按触发构建的事件筛选构建。 |
| build.previous_state | [字符串] | 按先前构建的状态筛选构建（用于查看状态是否已更改）。 |
| build.state | [字符串] | 按构建的当前状态筛选构建。 |
| created_by | [所有者] | 别名为build.created_by. |
| event_type | [字符串] | 别名为build.event_type. |
| include | [字符串] | 要 预加载 的属性列表。 |
| limit | 整数 | 响应中包含多少个构建。用于 分页。 |
| offset | 整数 | 响应中第一个条目之前的构建数量。用于 分页。 |
| previous_state | [字符串] | 别名为build.previous_state. |
| sort_by | [字符串] | 按属性对构建进行排序。用于 分页。 |
| state | [字符串] | 别名为build.state. |
可排序属性id, created_at, started_at, finished_at, number, 附加:desc到任何属性以反转顺序。
默认值为number:desc,id:desc.
GET
/repo/{repository.id}/builds
| 模板变量 | 类型 | 描述 |
|---|---|---|
| repository.id | 整数 | 唯一标识仓库的值。 |
| 查询参数 | 类型 | 描述 |
|---|---|---|
| branch.name | [字符串] | 按 Git 分支的名称筛选构建。 |
| build.created_by | [所有者] | 按创建构建的用户或组织筛选构建。 |
| build.event_type | [字符串] | 按触发构建的事件筛选构建。 |
| build.previous_state | [字符串] | 按先前构建的状态筛选构建（用于查看状态是否已更改）。 |
| build.state | [字符串] | 按构建的当前状态筛选构建。 |
| created_by | [所有者] | 别名为build.created_by. |
| event_type | [字符串] | 别名为build.event_type. |
| include | [字符串] | 要 预加载 的属性列表。 |
| limit | 整数 | 响应中包含多少个构建。用于 分页。 |
| offset | 整数 | 响应中第一个条目之前的构建数量。用于 分页。 |
| previous_state | [字符串] | 别名为build.previous_state. |
| sort_by | [字符串] | 按属性对构建进行排序。用于 分页。 |
| state | [字符串] | 别名为build.state. |
示例GET /repo/891/builds?limit=5
可排序属性id, created_at, started_at, finished_at, number, 附加:desc到任何属性以反转顺序。
默认值为number:desc,id:desc.
GET
/repo/{repository.slug}/builds
| 模板变量 | 类型 | 描述 |
|---|---|---|
| repository.slug | 字符串 | 与 {repository.owner.name}/{repository.name} 相同。 |
| 查询参数 | 类型 | 描述 |
|---|---|---|
| branch.name | [字符串] | 按 Git 分支的名称筛选构建。 |
| build.created_by | [所有者] | 按创建构建的用户或组织筛选构建。 |
| build.event_type | [字符串] | 按触发构建的事件筛选构建。 |
| build.previous_state | [字符串] | 按先前构建的状态筛选构建（用于查看状态是否已更改）。 |
| build.state | [字符串] | 按构建的当前状态筛选构建。 |
| created_by | [所有者] | 别名为build.created_by. |
| event_type | [字符串] | 别名为build.event_type. |
| include | [字符串] | 要 预加载 的属性列表。 |
| limit | 整数 | 响应中包含多少个构建。用于 分页。 |
| offset | 整数 | 响应中第一个条目之前的构建数量。用于 分页。 |
| previous_state | [字符串] | 别名为build.previous_state. |
| sort_by | [字符串] | 按属性对构建进行排序。用于 分页。 |
| state | [字符串] | 别名为build.state. |
示例GET /repo/rails%2Frails/builds?limit=5
可排序属性id, created_at, started_at, finished_at, number, 附加:desc到任何属性以反转顺序。
默认值为number:desc,id:desc.