Skip to content
Alex's Starlight Docs Alex's Starlight Docs
  • Auto
  • Light
  • Dark

Builds

Builds

Builds

Creates two builds whose outputs can be compared directly
client.builds.compare(BuildCompareParamsparams, RequestOptionsoptions?): baseBuildObjectheadBuildObjectBuildCompareResponse
post/v0/builds/compare
Create a new build
client.builds.create(BuildCreateParamsparams, RequestOptionsoptions?): idstringconfig_commitstringcreated_atstringdocumented_specunionobject"build"orgstringprojectstringtargetsTargetsupdated_atstringBuildObject
post/v0/builds
List builds for a project
client.builds.list(BuildListParamsparams?, RequestOptionsoptions?): Page<idstringconfig_commitstringcreated_atstringdocumented_specunionobject"build"orgstringprojectstringtargetsTargetsupdated_atstringBuildObject>
get/v0/builds
Retrieve a build by ID
client.builds.retrieve(stringbuildID, RequestOptionsoptions?): idstringconfig_commitstringcreated_atstringdocumented_specunionobject"build"orgstringprojectstringtargetsTargetsupdated_atstringBuildObject
get/v0/builds/{buildId}
Build Object
BuildObject
ShowShow
idstring
config_commitstring
created_atstring
formatdate-time
documented_specunion
contentstringtype"content"UnionMember0 | expiresstringtype"url"urlstringUnionMember1 | null
Hide ParametersShow Parameters
UnionMember0
Hide ParametersShow Parameters
contentstring
type"content"
Hide ParametersShow Parameters
"content"
UnionMember1
Hide ParametersShow Parameters
expiresstring
formatdate-time
type"url"
Hide ParametersShow Parameters
"url"
urlstring
object"build"
Hide ParametersShow Parameters
"build"
orgstring
projectstring
targetscliBuildTargetcsharpBuildTargetgoBuildTargetjavaBuildTargetkotlinBuildTargetnodeBuildTargetphpBuildTargetpythonBuildTargetrubyBuildTargetterraformBuildTargettypescriptBuildTargetTargets
Hide ParametersShow Parameters
clicommitunionlintCheckStepobject"build_target"statusuniontestCheckStepbuildCheckStepuploadCheckStepBuildTarget
optional
csharpcommitunionlintCheckStepobject"build_target"statusuniontestCheckStepbuildCheckStepuploadCheckStepBuildTarget
optional
gocommitunionlintCheckStepobject"build_target"statusuniontestCheckStepbuildCheckStepuploadCheckStepBuildTarget
optional
javacommitunionlintCheckStepobject"build_target"statusuniontestCheckStepbuildCheckStepuploadCheckStepBuildTarget
optional
kotlincommitunionlintCheckStepobject"build_target"statusuniontestCheckStepbuildCheckStepuploadCheckStepBuildTarget
optional
nodecommitunionlintCheckStepobject"build_target"statusuniontestCheckStepbuildCheckStepuploadCheckStepBuildTarget
optional
phpcommitunionlintCheckStepobject"build_target"statusuniontestCheckStepbuildCheckStepuploadCheckStepBuildTarget
optional
pythoncommitunionlintCheckStepobject"build_target"statusuniontestCheckStepbuildCheckStepuploadCheckStepBuildTarget
optional
rubycommitunionlintCheckStepobject"build_target"statusuniontestCheckStepbuildCheckStepuploadCheckStepBuildTarget
optional
terraformcommitunionlintCheckStepobject"build_target"statusuniontestCheckStepbuildCheckStepuploadCheckStepBuildTarget
optional
typescriptcommitunionlintCheckStepobject"build_target"statusuniontestCheckStepbuildCheckStepuploadCheckStepBuildTarget
optional
updated_atstring
formatdate-time
Build Target
BuildTarget
ShowShow
commitunion
status"not_started"NotStarted | status"queued"Queued | status"in_progress"InProgress | completedCompletedstatus"completed"Completed
Hide ParametersShow Parameters
NotStarted
Hide ParametersShow Parameters
status"not_started"
Hide ParametersShow Parameters
"not_started"
Queued
Hide ParametersShow Parameters
status"queued"
Hide ParametersShow Parameters
"queued"
InProgress
Hide ParametersShow Parameters
status"in_progress"
Hide ParametersShow Parameters
"in_progress"
Completed
Hide ParametersShow Parameters
completedcommitunionconclusionunionmerge_conflict_prunionCompleted
Hide ParametersShow Parameters
commitunion
repoReposhastringCommit | null
conclusionunion
"error" | "warning" | "note" | 9 more
Hide ParametersShow Parameters
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_prunion
numbernumberrepoRepoMergeConflictPr | null
Hide ParametersShow Parameters
numbernumber
reponamestringownerstringRepo
Hide ParametersShow Parameters
namestring
ownerstring
status"completed"
Hide ParametersShow Parameters
"completed"
object"build_target"
Hide ParametersShow Parameters
"build_target"
statusunion
"not_started" | "codegen" | "postgen" | "completed"
Hide ParametersShow Parameters
"not_started"
"codegen"
"postgen"
"completed"
buildCheckStep
optional
uploadCheckStep
optional
Check Step
CheckStepalias
status"not_started"Status | status"queued"Status | status"in_progress"Status | completedCompletedstatus"completed"UnionMember3
ShowShow
Status
Hide ParametersShow Parameters
status"not_started"
Hide ParametersShow Parameters
"not_started"
Status
Hide ParametersShow Parameters
status"queued"
Hide ParametersShow Parameters
"queued"
Status
Hide ParametersShow Parameters
status"in_progress"
Hide ParametersShow Parameters
"in_progress"
UnionMember3
Hide ParametersShow Parameters
completedconclusionunionurlunionCompleted
Hide ParametersShow Parameters
conclusionunion
"success" | "failure" | "skipped" | 4 more
Hide ParametersShow Parameters
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
urlunion
string | null
status"completed"
Hide ParametersShow Parameters
"completed"

BuildsDiagnostics

Get diagnostics for a build
client.builds.diagnostics.list(stringbuildID, DiagnosticListParamsquery?, RequestOptionsoptions?): Page<codestringignoredbooleanlevelunionmessagestringconfig_refstringoas_refstringDiagnosticListResponse>
get/v0/builds/{buildId}/diagnostics
Target
Targetalias
"node" | "typescript" | "python" | 8 more
ShowShow
"node"
"typescript"
"python"
"go"
"java"
"kotlin"
"ruby"
"terraform"
"cli"
"php"
"csharp"

BuildsTarget Outputs

Download the output of a build target
client.builds.targetOutputs.retrieve(TargetOutputRetrieveParamsquery, RequestOptionsoptions?): TargetOutputRetrieveResponse
get/v0/build_target_outputs