Creates two comparable builds

client.Builds.Compare(ctx, body) (*BuildCompareResponse, error)

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

body BuildCompareParams

Base param.Field[BuildCompareParamsBase]

Parameters for the base build

Branch string

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

Revision BuildCompareParamsBaseRevisionUnion

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

Accepts one of the following:

string

type BuildCompareParamsBaseRevisionMap map[string, FileInputUnion]

File contents to commit directly

Accepts one of the following:

FileInputContent

Content string

File content

FileInputURL

URL string

URL to fetch file content from

CommitMessage stringoptional

Optional commit message to use when creating a new commit.

Head param.Field[BuildCompareParamsHead]

Parameters for the head build

Branch string

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

Revision BuildCompareParamsHeadRevisionUnion

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

Accepts one of the following:

string

type BuildCompareParamsHeadRevisionMap map[string, FileInputUnion]

File contents to commit directly

Accepts one of the following:

FileInputContent

Content string

File content

FileInputURL

URL string

URL to fetch file content from

CommitMessage stringoptional

Optional commit message to use when creating a new commit.

Project param.Field[string]optional

Project name

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"

ReturnsExpand Collapse

type BuildCompareResponse struct{…}

Base Build

ID string

Build ID

ConfigCommit string

CreatedAt Time

DocumentedSpec BuildDocumentedSpecUnion

Accepts one of the following:

type BuildDocumentedSpecObject struct{…}

Content string

Type string

Accepts one of the following:

const BuildDocumentedSpecObjectTypeContent BuildDocumentedSpecObjectType = "content"

type BuildDocumentedSpecObject struct{…}

Expires Time

Type string

Accepts one of the following:

const BuildDocumentedSpecObjectTypeURL BuildDocumentedSpecObjectType = "url"

URL string

Object BuildObject

Accepts one of the following:

const BuildObjectBuild BuildObject = "build"

Org string

Project string

Targets BuildTargets

Cli BuildTargetoptional

Commit BuildTargetCommitUnion

Accepts one of the following:

type BuildTargetCommitNotStarted struct{…}

Status NotStarted

Accepts one of the following:

const NotStartedNotStarted NotStarted = "not_started"

type BuildTargetCommitQueued struct{…}

Status Queued

Accepts one of the following:

const QueuedQueued Queued = "queued"

type BuildTargetCommitInProgress struct{…}

Status InProgress

Accepts one of the following:

const InProgressInProgress InProgress = "in_progress"

type BuildTargetCommitCompleted struct{…}

Completed BuildTargetCommitCompletedCompleted

Commit Commit

Repo CommitRepo

Branch string

Name string

Owner string

Sha string

Conclusion string

Accepts 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

Name string

Owner string

Status Completed

Accepts one of the following:

const CompletedCompleted Completed = "completed"

InstallURL string

Lint CheckStepUnion

Accepts one of the following:

type CheckStepNotStarted struct{…}

Status NotStarted

Accepts one of the following:

const NotStartedNotStarted NotStarted = "not_started"

type CheckStepQueued struct{…}

Status Queued

Accepts one of the following:

const QueuedQueued Queued = "queued"

type CheckStepInProgress struct{…}

Status InProgress

Accepts one of the following:

const InProgressInProgress InProgress = "in_progress"

type CheckStepCompleted struct{…}

Completed CheckStepCompletedCompleted

Conclusion string

Accepts 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

Status Completed

Accepts one of the following:

const CompletedCompleted Completed = "completed"

Object BuildTargetObject

Accepts one of the following:

const BuildTargetObjectBuildTarget BuildTargetObject = "build_target"

Status BuildTargetStatus

Accepts one of the following:

const BuildTargetStatusNotStarted BuildTargetStatus = "not_started"

const BuildTargetStatusCodegen BuildTargetStatus = "codegen"

const BuildTargetStatusPostgen BuildTargetStatus = "postgen"

const BuildTargetStatusCompleted BuildTargetStatus = "completed"

Test CheckStepUnion

Accepts one of the following:

type CheckStepNotStarted struct{…}

Status NotStarted

Accepts one of the following:

const NotStartedNotStarted NotStarted = "not_started"

type CheckStepQueued struct{…}

Status Queued

Accepts one of the following:

const QueuedQueued Queued = "queued"

type CheckStepInProgress struct{…}

Status InProgress

Accepts one of the following:

const InProgressInProgress InProgress = "in_progress"

type CheckStepCompleted struct{…}

Completed CheckStepCompletedCompleted

Conclusion string

Accepts 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

Status Completed

Accepts one of the following:

const CompletedCompleted Completed = "completed"

Build CheckStepUnionoptional

Accepts one of the following:

type CheckStepNotStarted struct{…}

Status NotStarted

Accepts one of the following:

const NotStartedNotStarted NotStarted = "not_started"

type CheckStepQueued struct{…}

Status Queued

Accepts one of the following:

const QueuedQueued Queued = "queued"

type CheckStepInProgress struct{…}

Status InProgress

Accepts one of the following:

const InProgressInProgress InProgress = "in_progress"

type CheckStepCompleted struct{…}

Completed CheckStepCompletedCompleted

Conclusion string

Accepts 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

Status Completed

Accepts one of the following:

const CompletedCompleted Completed = "completed"

Csharp BuildTargetoptional