Create build

client.Builds.New(ctx, body) (*Build, error)

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

body BuildNewParams

Project param.Field[string]optional

Project name

Revision param.Field[BuildNewParamsRevisionUnion]

Specifies what to build: a branch name, commit SHA, merge command ("base..head"), or file contents.

string

type BuildNewParamsRevisionMap map[string, FileInputUnion]

File contents to commit directly

One of the following:

FileInputContent

Content string

File content

FileInputURL

URL string

URL to fetch file content from

AllowEmpty param.Field[bool]optional

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

Branch param.Field[string]optional

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.

CommitMessage param.Field[string]optional

Optional commit message to use when creating a new commit.

EnableAICommitMessage param.Field[bool]optional

Whether to generate AI-powered commit messages for the build. Cannot be combined with commit_message or target_commit_messages.

TargetCommitMessages param.Field[BuildNewParamsTargetCommitMessages]optional

Optional commit messages to use for each SDK when making a new commit. SDKs not represented in this object will fallback to the optional commit_message parameter, or will fallback further to the default commit message.

Cli stringoptional

Csharp stringoptional

Go stringoptional

Java stringoptional

Kotlin stringoptional

Node stringoptional

OpenAPI stringoptional

Php stringoptional

Python stringoptional

Ruby stringoptional

Sql stringoptional

Terraform stringoptional

Typescript stringoptional

Targets param.Field[[]Target]optional

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

const TargetNode Target = "node"

const TargetTypescript Target = "typescript"

const TargetPython Target = "python"

const TargetGo Target = "go"

const TargetJava Target = "java"

const TargetKotlin Target = "kotlin"

const TargetRuby Target = "ruby"

const TargetTerraform Target = "terraform"

const TargetCli Target = "cli"

const TargetPhp Target = "php"

const TargetCsharp Target = "csharp"

const TargetSql Target = "sql"

const TargetOpenAPI Target = "openapi"

ReturnsExpand Collapse

type Build struct{…}

ID string

Build ID

ConfigCommit string

CreatedAt Time

DocumentedSpec BuildDocumentedSpecUnion

One of the following:

type BuildDocumentedSpecObject struct{…}

Content string

Type string

type BuildDocumentedSpecObject struct{…}

Expires Time

Type string

URL string

Object BuildObject

Org string

Project string

Targets BuildTargets

Cli BuildTargetoptional

Commit BuildTargetCommitUnion

One of the following:

type BuildTargetCommitNotStarted struct{…}

Status NotStarted

type BuildTargetCommitQueued struct{…}

Status Queued

type BuildTargetCommitInProgress struct{…}

Status InProgress

type BuildTargetCommitCompleted struct{…}

Commit Commit

Repo CommitRepo

Branch string

Host string

Name string

Owner string

Sha string

Stats CommitStats

Additions int64

Deletions int64

Total int64

TreeOid string

Completed BuildTargetCommitCompletedCompleted

deprecated

Commit Commit

Repo CommitRepo

Branch string

Host string

Name string

Owner string

Sha string

Stats CommitStats

Additions int64

Deletions int64

Total int64

TreeOid string

CompletedAt Time

Conclusion string

One of the following:

const BuildTargetCommitCompletedCompletedConclusionError BuildTargetCommitCompletedCompletedConclusion = "error"

const BuildTargetCommitCompletedCompletedConclusionWarning BuildTargetCommitCompletedCompletedConclusion = "warning"

const BuildTargetCommitCompletedCompletedConclusionNote BuildTargetCommitCompletedCompletedConclusion = "note"

const BuildTargetCommitCompletedCompletedConclusionSuccess BuildTargetCommitCompletedCompletedConclusion = "success"

const BuildTargetCommitCompletedCompletedConclusionMergeConflict BuildTargetCommitCompletedCompletedConclusion = "merge_conflict"

const BuildTargetCommitCompletedCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedCompletedConclusion = "upstream_merge_conflict"

const BuildTargetCommitCompletedCompletedConclusionFatal BuildTargetCommitCompletedCompletedConclusion = "fatal"

const BuildTargetCommitCompletedCompletedConclusionPaymentRequired BuildTargetCommitCompletedCompletedConclusion = "payment_required"

const BuildTargetCommitCompletedCompletedConclusionCancelled BuildTargetCommitCompletedCompletedConclusion = "cancelled"

const BuildTargetCommitCompletedCompletedConclusionTimedOut BuildTargetCommitCompletedCompletedConclusion = "timed_out"

const BuildTargetCommitCompletedCompletedConclusionNoop BuildTargetCommitCompletedCompletedConclusion = "noop"

const BuildTargetCommitCompletedCompletedConclusionVersionBump BuildTargetCommitCompletedCompletedConclusion = "version_bump"

MergeConflictPr BuildTargetCommitCompletedCompletedMergeConflictPr

Number float64

Repo BuildTargetCommitCompletedCompletedMergeConflictPrRepo

Host string

Name string

Owner string

CompletedAt Time

Conclusion string

One of the following:

const BuildTargetCommitCompletedConclusionError BuildTargetCommitCompletedConclusion = "error"

const BuildTargetCommitCompletedConclusionWarning BuildTargetCommitCompletedConclusion = "warning"

const BuildTargetCommitCompletedConclusionNote BuildTargetCommitCompletedConclusion = "note"

const BuildTargetCommitCompletedConclusionSuccess BuildTargetCommitCompletedConclusion = "success"

const BuildTargetCommitCompletedConclusionMergeConflict BuildTargetCommitCompletedConclusion = "merge_conflict"

const BuildTargetCommitCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedConclusion = "upstream_merge_conflict"

const BuildTargetCommitCompletedConclusionFatal BuildTargetCommitCompletedConclusion = "fatal"

const BuildTargetCommitCompletedConclusionPaymentRequired BuildTargetCommitCompletedConclusion = "payment_required"

const BuildTargetCommitCompletedConclusionCancelled BuildTargetCommitCompletedConclusion = "cancelled"

const BuildTargetCommitCompletedConclusionTimedOut BuildTargetCommitCompletedConclusion = "timed_out"

const BuildTargetCommitCompletedConclusionNoop BuildTargetCommitCompletedConclusion = "noop"

const BuildTargetCommitCompletedConclusionVersionBump BuildTargetCommitCompletedConclusion = "version_bump"

MergeConflictPr BuildTargetCommitCompletedMergeConflictPr

Number float64

Repo BuildTargetCommitCompletedMergeConflictPrRepo

Host string

Name string

Owner string

Status Completed

InstallURL string

Object BuildTargetObject

Status BuildTargetStatus

One of the following:

const BuildTargetStatusNotStarted BuildTargetStatus = "not_started"

const BuildTargetStatusCodegen BuildTargetStatus = "codegen"

const BuildTargetStatusPostgen BuildTargetStatus = "postgen"

const BuildTargetStatusCompleted BuildTargetStatus = "completed"

Build CheckStepUnionoptional

One of the following:

type CheckStepNotStarted struct{…}

Status NotStarted

type CheckStepQueued struct{…}

Status Queued

URL string

type CheckStepInProgress struct{…}

Status InProgress

URL string

type CheckStepCompleted struct{…}

Completed CheckStepCompletedCompleted

deprecated

Conclusion string

One of the following:

const CheckStepCompletedCompletedConclusionSuccess CheckStepCompletedCompletedConclusion = "success"

const CheckStepCompletedCompletedConclusionFailure CheckStepCompletedCompletedConclusion = "failure"

const CheckStepCompletedCompletedConclusionSkipped CheckStepCompletedCompletedConclusion = "skipped"

const CheckStepCompletedCompletedConclusionCancelled CheckStepCompletedCompletedConclusion = "cancelled"

const CheckStepCompletedCompletedConclusionActionRequired CheckStepCompletedCompletedConclusion = "action_required"

const CheckStepCompletedCompletedConclusionNeutral CheckStepCompletedCompletedConclusion = "neutral"

const CheckStepCompletedCompletedConclusionTimedOut CheckStepCompletedCompletedConclusion = "timed_out"

URL string

Conclusion string

One of the following:

const CheckStepCompletedConclusionSuccess CheckStepCompletedConclusion = "success"

const CheckStepCompletedConclusionFailure CheckStepCompletedConclusion = "failure"

const CheckStepCompletedConclusionSkipped CheckStepCompletedConclusion = "skipped"

const CheckStepCompletedConclusionCancelled CheckStepCompletedConclusion = "cancelled"

const CheckStepCompletedConclusionActionRequired CheckStepCompletedConclusion = "action_required"

const CheckStepCompletedConclusionNeutral CheckStepCompletedConclusion = "neutral"

const CheckStepCompletedConclusionTimedOut CheckStepCompletedConclusion = "timed_out"

Status Completed

URL string

Lint CheckStepUnionoptional

One of the following:

type CheckStepNotStarted struct{…}

Status NotStarted

type CheckStepQueued struct{…}

Status Queued

URL string

type CheckStepInProgress struct{…}

Status InProgress

URL string

type CheckStepCompleted struct{…}

Completed CheckStepCompletedCompleted

deprecated

Conclusion string

One of the following:

const CheckStepCompletedCompletedConclusionSuccess CheckStepCompletedCompletedConclusion = "success"

const CheckStepCompletedCompletedConclusionFailure CheckStepCompletedCompletedConclusion = "failure"

const CheckStepCompletedCompletedConclusionSkipped CheckStepCompletedCompletedConclusion = "skipped"

const CheckStepCompletedCompletedConclusionCancelled CheckStepCompletedCompletedConclusion = "cancelled"

const CheckStepCompletedCompletedConclusionActionRequired CheckStepCompletedCompletedConclusion = "action_required"

const CheckStepCompletedCompletedConclusionNeutral CheckStepCompletedCompletedConclusion = "neutral"

const CheckStepCompletedCompletedConclusionTimedOut CheckStepCompletedCompletedConclusion = "timed_out"

URL string

Conclusion string

One of the following:

const CheckStepCompletedConclusionSuccess CheckStepCompletedConclusion = "success"

const CheckStepCompletedConclusionFailure CheckStepCompletedConclusion = "failure"

const CheckStepCompletedConclusionSkipped CheckStepCompletedConclusion = "skipped"

const CheckStepCompletedConclusionCancelled CheckStepCompletedConclusion = "cancelled"

const CheckStepCompletedConclusionActionRequired CheckStepCompletedConclusion = "action_required"

const CheckStepCompletedConclusionNeutral CheckStepCompletedConclusion = "neutral"

const CheckStepCompletedConclusionTimedOut CheckStepCompletedConclusion = "timed_out"

Status Completed

URL string

Test CheckStepUnionoptional

One of the following:

type CheckStepNotStarted struct{…}

Status NotStarted

type CheckStepQueued struct{…}

Status Queued

URL string

type CheckStepInProgress struct{…}

Status InProgress

URL string

type CheckStepCompleted struct{…}

Completed CheckStepCompletedCompleted

deprecated

Conclusion string

One of the following:

const CheckStepCompletedCompletedConclusionSuccess CheckStepCompletedCompletedConclusion = "success"

const CheckStepCompletedCompletedConclusionFailure CheckStepCompletedCompletedConclusion = "failure"

const CheckStepCompletedCompletedConclusionSkipped CheckStepCompletedCompletedConclusion = "skipped"

const CheckStepCompletedCompletedConclusionCancelled CheckStepCompletedCompletedConclusion = "cancelled"

const CheckStepCompletedCompletedConclusionActionRequired CheckStepCompletedCompletedConclusion = "action_required"

const CheckStepCompletedCompletedConclusionNeutral CheckStepCompletedCompletedConclusion = "neutral"

const CheckStepCompletedCompletedConclusionTimedOut CheckStepCompletedCompletedConclusion = "timed_out"

URL string

Conclusion string

One of the following:

const CheckStepCompletedConclusionSuccess CheckStepCompletedConclusion = "success"

const CheckStepCompletedConclusionFailure CheckStepCompletedConclusion = "failure"

const CheckStepCompletedConclusionSkipped CheckStepCompletedConclusion = "skipped"

const CheckStepCompletedConclusionCancelled CheckStepCompletedConclusion = "cancelled"

const CheckStepCompletedConclusionActionRequired CheckStepCompletedConclusion = "action_required"

const CheckStepCompletedConclusionNeutral CheckStepCompletedConclusion = "neutral"

const CheckStepCompletedConclusionTimedOut CheckStepCompletedConclusion = "timed_out"

Status Completed

URL string

Csharp BuildTargetoptional