Retrieve a project branch

client.Projects.Branches.Get(ctx, branch, query) (*ProjectBranch, error)

get/v0/projects/{project}/branches/{branch}

Retrieve a project branch by name.

ParametersExpand Collapse

branch string

query ProjectBranchGetParams

Project param.Field[string]optional

ReturnsExpand Collapse

type ProjectBranch struct{…}

A project branch names a line of development for a project. Like a Git branch, it points to a Git commit with a set of config files. In addition, a project branch also points to a set of custom code changes, corresponding to Git branches in the staging repos.

Branch string

Branch name

ConfigCommit ProjectBranchConfigCommit

A Git commit that points to the latest set of config files on a given branch.

Repo ProjectBranchConfigCommitRepo

Branch string

Name string

Owner string

Sha string

LatestBuild 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