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
builds.compare(BuildCompareParams**kwargs) -> baseBuildObjectheadBuildObjectBuildCompareResponse
post/v0/builds/compare
Create a new build
builds.create(BuildCreateParams**kwargs) -> idstrconfig_commitstrcreated_atdatetimedocumented_specDocumentedSpecobjectliteralorgstrprojectstrtargetsTargetsupdated_atdatetimeBuildObject
post/v0/builds
List builds for a project
builds.list(BuildListParams**kwargs) -> SyncPage[idstrconfig_commitstrcreated_atdatetimedocumented_specDocumentedSpecobjectliteralorgstrprojectstrtargetsTargetsupdated_atdatetimeBuildObject]
get/v0/builds
Retrieve a build by ID
builds.retrieve(strbuild_id) -> idstrconfig_commitstrcreated_atdatetimedocumented_specDocumentedSpecobjectliteralorgstrprojectstrtargetsTargetsupdated_atdatetimeBuildObject
get/v0/builds/{buildId}
Build Object
BuildObjectclass
ShowShow
idstr
config_commitstr
created_atdatetime
formatdate-time
documented_specDocumentedSpec
Hide ParametersShow Parameters
DocumentedSpecUnionMember0class
Hide ParametersShow Parameters
contentstr
typeliteral
Literal["content"]
Hide ParametersShow Parameters
"content"
DocumentedSpecUnionMember1class
Hide ParametersShow Parameters
expiresdatetime
formatdate-time
typeliteral
Literal["url"]
Hide ParametersShow Parameters
"url"
urlstr
objectliteral
Literal["build"]
Hide ParametersShow Parameters
"build"
orgstr
projectstr
targetscliBuildTargetcsharpBuildTargetgoBuildTargetjavaBuildTargetkotlinBuildTargetnodeBuildTargetphpBuildTargetpythonBuildTargetrubyBuildTargetterraformBuildTargettypescriptBuildTargetTargets
Hide ParametersShow Parameters
cliBuildTarget
optional
csharpBuildTarget
optional
goBuildTarget
optional
javaBuildTarget
optional
kotlinBuildTarget
optional
nodeBuildTarget
optional
phpBuildTarget
optional
pythonBuildTarget
optional
rubyBuildTarget
optional
terraformBuildTarget
optional
typescriptBuildTarget
optional
updated_atdatetime
formatdate-time
Build Target
BuildTargetclass
ShowShow
commitCommit
Hide ParametersShow Parameters
CommitNotStartedclass
Hide ParametersShow Parameters
statusliteral
Literal["not_started"]
Hide ParametersShow Parameters
"not_started"
CommitQueuedclass
Hide ParametersShow Parameters
statusliteral
Literal["queued"]
Hide ParametersShow Parameters
"queued"
CommitInProgressclass
Hide ParametersShow Parameters
statusliteral
Literal["in_progress"]
Hide ParametersShow Parameters
"in_progress"
CommitCompletedclass
Hide ParametersShow Parameters
completedcommitCommitconclusionliteralmerge_conflict_prCommitCompletedCompletedMergeConflictPrCommitCompletedCompleted
Hide ParametersShow Parameters
commitCommit
conclusionliteral
Literal["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_prnumberfloatrepoCommitCompletedCompletedMergeConflictPrRepoCommitCompletedCompletedMergeConflictPr
Hide ParametersShow Parameters
numberfloat
reponamestrownerstrCommitCompletedCompletedMergeConflictPrRepo
Hide ParametersShow Parameters
namestr
ownerstr
statusliteral
Literal["completed"]
Hide ParametersShow Parameters
"completed"
objectliteral
Literal["build_target"]
Hide ParametersShow Parameters
"build_target"
statusliteral
Literal["not_started", "codegen", "postgen", "completed"]
Hide ParametersShow Parameters
"not_started"
"codegen"
"postgen"
"completed"
buildCheckStep
optional
uploadCheckStep
optional
Check Step
CheckSteptype
CheckStep
ShowShow
Statusclass
Hide ParametersShow Parameters
statusliteral
Literal["not_started"]
Hide ParametersShow Parameters
"not_started"
Statusclass
Hide ParametersShow Parameters
statusliteral
Literal["queued"]
Hide ParametersShow Parameters
"queued"
Statusclass
Hide ParametersShow Parameters
statusliteral
Literal["in_progress"]
Hide ParametersShow Parameters
"in_progress"
UnionMember3class
Hide ParametersShow Parameters
completedconclusionliteralurlstrUnionMember3Completed
Hide ParametersShow Parameters
conclusionliteral
Literal["success", "failure", "skipped", 4 more]
Hide ParametersShow Parameters
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
urlstr
statusliteral
Literal["completed"]
Hide ParametersShow Parameters
"completed"

BuildsDiagnostics

Get diagnostics for a build
builds.diagnostics.list(strbuild_id, DiagnosticListParams**kwargs) -> SyncPage[codestrignoredboollevelliteralmessagestrconfig_refstroas_refstrDiagnosticListResponse]
get/v0/builds/{buildId}/diagnostics
Target
Targettype
Literal["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
builds.target_outputs.retrieve(TargetOutputRetrieveParams**kwargs) -> TargetOutputRetrieveResponse
get/v0/build_target_outputs