Reference

builds

Builds of a repository ref or an uploaded tarball: probed in a sandbox, planned with a preset, built on a build machine. Index · shared schemas · errors.

builds.create

Start a build of a git ref (or of a tarball uploaded next): probe, plan with a preset, build in a sandbox, store the artifacts

Input:

{
  projectId: ProjectId
  source: BuildSourceInput
  appRoot?: RelativePath
  osFamily: BuildOsFamilyIn
  target: BuildTargetIn
  configuration?: BuildConfigurationIn
  preset?: PresetId
  presetOptions?: PresetOptions
  stepOverrides?: StepOverride[]  // ≤ 16 items
  cache?: BuildCacheOptions
  trigger?: BuildTrigger
  timeoutMs?: integer  // 60000–10800000
  signing?: CredentialId | 'none'
  env?: BuildEnvValues
}

Output:

{ build: CloudBuild; upload?: CloudUpload }

Errors: U, NOT_FOUND, ORG_SUSPENDED, PROJECT_SUSPENDED, QUOTA_EXCEEDED, CAPACITY_UNAVAILABLE.

Named types: BuildCacheOptions, BuildConfigurationIn, BuildEnvValues, BuildOsFamilyIn, BuildSourceInput, BuildTargetIn, BuildTrigger, CloudBuild, CloudUpload, CredentialId, PresetId, PresetOptions, ProjectId, RelativePath, StepOverride.

builds.get

A build: its status, the probed revision, the plan it chose (preset, image digest) and its artifacts

Input:

{ projectId: ProjectId; buildId: BuildId }

Output:

{ build: CloudBuild }

Errors: U, NOT_FOUND.

Named types: BuildId, CloudBuild, ProjectId.

builds.list

A project's builds, newest first

Input:

{ projectId: ProjectId; limit?: PageLimit; cursor?: PageCursor }

Output:

{ builds: CloudBuild[]; nextCursor?: string }

Errors: U, NOT_FOUND.

Named types: CloudBuild, PageCursor, PageLimit, ProjectId.

builds.cancel

Cancel a build: an unfinished one ends canceled and its machine is stopped; a finished one is returned as is

Input:

{ projectId: ProjectId; buildId: BuildId }

Output:

{ build: CloudBuild }

Errors: U, NOT_FOUND, CONFLICT.

Named types: BuildId, CloudBuild, ProjectId.

builds.logs

Replay a build's log from since, then follow it until the build ends

Input:

{ projectId: ProjectId; buildId: BuildId; since?: Seq; follow?: boolean }

Output: an event iterator (text/event-stream on REST), each event:

BuildLogLine

Errors: U, NOT_FOUND.

Named types: BuildId, BuildLogLine, ProjectId, Seq.