Skip to content
Stainless Stainless Stainless
FeedbackDashboard
API Reference
Builds

Creates two comparable builds

client.builds.compare(BuildCompareParams { base, head, project, targets } params, RequestOptionsoptions?): BuildCompareResponse { base, head }
post/v0/builds/compare

Create two builds whose outputs can be directly compared with each other.

Created builds modify their project branches so that their latest sets of config files point to the ones specified by the input revision.

This endpoint is useful because a build has more inputs than the set of config files it uses, so comparing two builds directly may return spurious differences. Builds made via this endpoint are guaranteed to have differences arising from the set of config files, and any custom code.

ParametersExpand Collapse
params: BuildCompareParams { base, head, project, targets }
base: Base

Parameters for the base build

branch: string

Branch to use. When using a branch name as revision, this must match or be omitted.

revision: string | Record<string, FileInput>

Specifies what to build: a branch name, a commit SHA, or file contents.

Accepts one of the following:
string
Record<string, FileInput>
Content { content }
content: string

File content

URL { url }
url: string

URL to fetch file content from

commit_message?: string

Optional commit message to use when creating a new commit.

head: Head

Parameters for the head build

branch: string

Branch to use. When using a branch name as revision, this must match or be omitted.

revision: string | Record<string, FileInput>

Specifies what to build: a branch name, a commit SHA, or file contents.

Accepts one of the following:
string
Record<string, FileInput>
Content { content }
content: string

File content

URL { url }
url: string

URL to fetch file content from

commit_message?: string

Optional commit message to use when creating a new commit.

project?: string

Project name

targets?: Array<Target>

Optional list of SDK targets to build. If not specified, all configured targets will be built.

Accepts one of the following:
"node"
"typescript"
"python"
"go"
"java"
"kotlin"
"ruby"
"terraform"
"cli"
"php"
"csharp"
"openapi"
ReturnsExpand Collapse
BuildCompareResponse { base, head }
base: Build { id, config_commit, created_at, 6 more }
id: string

Build ID

config_commit: string
created_at: string
documented_spec: UnionMember0 { content, type } | UnionMember1 { expires, type, url } | null
Accepts one of the following:
UnionMember0 { content, type }
content: string
type: "content"
UnionMember1 { expires, type, url }
expires: string
type: "url"
url: string
object: "build"
org: string
project: string
targets: Targets { cli, csharp, go, 9 more }
cli?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
csharp?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
go?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
java?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
kotlin?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
node?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
openapi?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
php?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
python?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
ruby?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
terraform?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
typescript?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
updated_at: string
head: Build { id, config_commit, created_at, 6 more }
id: string

Build ID

config_commit: string
created_at: string
documented_spec: UnionMember0 { content, type } | UnionMember1 { expires, type, url } | null
Accepts one of the following:
UnionMember0 { content, type }
content: string
type: "content"
UnionMember1 { expires, type, url }
expires: string
type: "url"
url: string
object: "build"
org: string
project: string
targets: Targets { cli, csharp, go, 9 more }
cli?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
csharp?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
go?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
java?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
kotlin?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
node?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
openapi?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
php?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
python?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
ruby?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
terraform?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
typescript?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
updated_at: string
Creates two comparable builds
import Stainless from '@stainless-api/sdk';

const client = new Stainless({
  apiKey: process.env['STAINLESS_API_KEY'], // This is the default and can be omitted
});

const response = await client.builds.compare({
  base: { branch: 'branch', revision: 'string' },
  head: { branch: 'branch', revision: 'string' },
  project: 'project',
});

console.log(response.base);
{
  "base": {
    "id": "id",
    "config_commit": "config_commit",
    "created_at": "2019-12-27T18:11:19.117Z",
    "documented_spec": {
      "content": "content",
      "type": "content"
    },
    "object": "build",
    "org": "org",
    "project": "project",
    "targets": {
      "cli": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "csharp": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "go": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "java": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "kotlin": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "node": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "openapi": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "php": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "python": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "ruby": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "terraform": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "typescript": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      }
    },
    "updated_at": "2019-12-27T18:11:19.117Z"
  },
  "head": {
    "id": "id",
    "config_commit": "config_commit",
    "created_at": "2019-12-27T18:11:19.117Z",
    "documented_spec": {
      "content": "content",
      "type": "content"
    },
    "object": "build",
    "org": "org",
    "project": "project",
    "targets": {
      "cli": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "csharp": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "go": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "java": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "kotlin": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "node": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "openapi": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "php": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "python": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "ruby": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "terraform": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "typescript": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      }
    },
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
}
Returns Examples
{
  "base": {
    "id": "id",
    "config_commit": "config_commit",
    "created_at": "2019-12-27T18:11:19.117Z",
    "documented_spec": {
      "content": "content",
      "type": "content"
    },
    "object": "build",
    "org": "org",
    "project": "project",
    "targets": {
      "cli": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "csharp": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "go": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "java": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "kotlin": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "node": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "openapi": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "php": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "python": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "ruby": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "terraform": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "typescript": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      }
    },
    "updated_at": "2019-12-27T18:11:19.117Z"
  },
  "head": {
    "id": "id",
    "config_commit": "config_commit",
    "created_at": "2019-12-27T18:11:19.117Z",
    "documented_spec": {
      "content": "content",
      "type": "content"
    },
    "object": "build",
    "org": "org",
    "project": "project",
    "targets": {
      "cli": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "csharp": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "go": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "java": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "kotlin": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "node": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "openapi": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "php": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "python": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "ruby": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "terraform": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "typescript": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      }
    },
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
}