v1

latestSwagger 2.02026-08-06114111152.5 KB

Builds

Link a build to a commit for CI status checks

Associates a CI build with the commit/PR it ran for on a code host and posts an in-progress status check. Currently supports github (requires the TestingBot GitHub App installed on the repository owner). Call this at the start of a workflow run.

post/v1/builds/{id}/ci

Path parameters

idstring required

Build identifier (capabilities.build) for this run.

Request body

repostring required

Repository in owner/name form.

commit_shastring required

Head commit SHA the build ran for. For pull_request events use github.event.pull_request.head.sha (not the merge commit) so the check lands on the SHA branch protection evaluates.

providerstring

Code host provider. Currently only "github".

branchstring

Git branch name.

pull_request_numberinteger

Pull request number, if any.

Response

Link a build to a commit for CI status checks

successboolean required

Whether the operation succeeded.

errorsobject required

Validation errors keyed by field name. Only present when success is false.

errorstring required

Single human-readable reason, used by the older endpoints in place of errors. Only present when success is false.