Create build

client.builds.create(, ?): Build { id, config_commit, created_at, 6 more }

post/v0/builds

Create a build, on top of a project branch, against a given input revision.

The project branch will be modified so that its latest set of config files points to the one specified by the input revision.

ParametersExpand Collapse

params: BuildCreateParams { project, revision, allow_empty, 3 more }

project?: string

Project name

revision: string | Record<string, FileInput>

Specifies what to build: a branch name, commit SHA, merge command ("base..head"), 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

allow_empty?: boolean

Whether to allow empty commits (no changes). Defaults to false.

branch?: string

The project branch to use for the build. If not specified, the branch is inferred from the revision, and will 400 when that is not possible.

commit_message?: string

Optional commit message to use when creating a new commit.

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"

ReturnsExpand Collapse

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"

Accepts one of the following:

"content"

UnionMember1 { expires, type, url }

expires: string

type: "url"

Accepts one of the following:

"url"

url: string

object: "build"

Accepts one of the following:

"build"

org: string

project: string

targets: Targets { cli, csharp, go, 8 more }

cli?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

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 }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"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"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

csharp?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

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 }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"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"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

go?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

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 }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"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"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

java?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

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 }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"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"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

kotlin?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

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 }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"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"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

node?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

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 }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"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"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

php?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

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 }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"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"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

python?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

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 }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"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"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

ruby?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

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 }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"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"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

terraform?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

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 }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"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"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

typescript?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

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 }

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"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"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

updated_at: string

Create build

IMPORT STAINLESS FROM '@STAINLESS-API/SDK';

CONST CLIENT = NEW STAINLESS({
  APIKEY: 'MY API KEY',
});

CONST BUILD = AWAIT CLIENT.BUILDS.CREATE({ PROJECT: 'PROJECT', REVISION: 'STRING' });

CONSOLE.LOG(BUILD.ID);

{
  "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"
      }
    },
    "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

{
  "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"
      }
    },
    "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"
}