Skip to content
FeedbackDashboard

Branches

Create a new project branch
projects.branches.create(**kwargs) -> ProjectBranch { branch, config_commit, latest_build, 3 more }
POST/v0/projects/{project}/branches
Retrieve a project branch
projects.branches.retrieve(branch, **kwargs) -> ProjectBranch { branch, config_commit, latest_build, 3 more }
GET/v0/projects/{project}/branches/{branch}
List project branches
projects.branches.list(**kwargs) -> Page<BranchListResponse { branch, config_commit, latest_build_id, 3 more } >
GET/v0/projects/{project}/branches
Delete a project branch
projects.branches.delete(branch, **kwargs) -> BranchDeleteResponse
DELETE/v0/projects/{project}/branches/{branch}
Rebase a project branch
projects.branches.rebase(branch, **kwargs) -> ProjectBranch { branch, config_commit, latest_build, 3 more }
PUT/v0/projects/{project}/branches/{branch}/rebase
Reset
projects.branches.reset(branch, **kwargs) -> ProjectBranch { branch, config_commit, latest_build, 3 more }
PUT/v0/projects/{project}/branches/{branch}/reset
ModelsExpand Collapse
class ProjectBranch { branch, config_commit, latest_build, 3 more }

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

config_commit: { repo, sha, stats, tree_oid}

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

repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
latest_build: Build { id, config_commit, created_at, 6 more }
id: String

Build ID

config_commit: String
created_at: Time
documented_spec: { content, type} | { expires, type, url}
One of the following:
class UnionMember0 { content, type }
content: String
type: :content
class UnionMember1 { expires, type, url }
expires: Time
type: :url
url: String
object: :build
org: String
project: String
targets: { cli, csharp, go, 10 more}
cli: BuildTarget { commit, install_url, object, 4 more }
commit: { status} | { status} | { status} | { commit, completed, completed_at, 3 more}
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status }
status: :queued
class InProgress { status }
status: :in_progress
class Completed { commit, completed, completed_at, 3 more }
commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed: { commit, completed_at, conclusion, merge_conflict_pr}

deprecated

commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
status: :completed
install_url: String
object: :build_target
status: :not_started | :codegen | :postgen | :completed
One of the following:
:not_started
:codegen
:postgen
:completed
build: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
lint: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
test_: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
csharp: BuildTarget { commit, install_url, object, 4 more }
commit: { status} | { status} | { status} | { commit, completed, completed_at, 3 more}
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status }
status: :queued
class InProgress { status }
status: :in_progress
class Completed { commit, completed, completed_at, 3 more }
commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed: { commit, completed_at, conclusion, merge_conflict_pr}

deprecated

commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
status: :completed
install_url: String
object: :build_target
status: :not_started | :codegen | :postgen | :completed
One of the following:
:not_started
:codegen
:postgen
:completed
build: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
lint: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
test_: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
go: BuildTarget { commit, install_url, object, 4 more }
commit: { status} | { status} | { status} | { commit, completed, completed_at, 3 more}
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status }
status: :queued
class InProgress { status }
status: :in_progress
class Completed { commit, completed, completed_at, 3 more }
commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed: { commit, completed_at, conclusion, merge_conflict_pr}

deprecated

commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
status: :completed
install_url: String
object: :build_target
status: :not_started | :codegen | :postgen | :completed
One of the following:
:not_started
:codegen
:postgen
:completed
build: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
lint: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
test_: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
java: BuildTarget { commit, install_url, object, 4 more }
commit: { status} | { status} | { status} | { commit, completed, completed_at, 3 more}
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status }
status: :queued
class InProgress { status }
status: :in_progress
class Completed { commit, completed, completed_at, 3 more }
commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed: { commit, completed_at, conclusion, merge_conflict_pr}

deprecated

commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
status: :completed
install_url: String
object: :build_target
status: :not_started | :codegen | :postgen | :completed
One of the following:
:not_started
:codegen
:postgen
:completed
build: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
lint: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
test_: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
kotlin: BuildTarget { commit, install_url, object, 4 more }
commit: { status} | { status} | { status} | { commit, completed, completed_at, 3 more}
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status }
status: :queued
class InProgress { status }
status: :in_progress
class Completed { commit, completed, completed_at, 3 more }
commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed: { commit, completed_at, conclusion, merge_conflict_pr}

deprecated

commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
status: :completed
install_url: String
object: :build_target
status: :not_started | :codegen | :postgen | :completed
One of the following:
:not_started
:codegen
:postgen
:completed
build: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
lint: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
test_: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
node: BuildTarget { commit, install_url, object, 4 more }
commit: { status} | { status} | { status} | { commit, completed, completed_at, 3 more}
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status }
status: :queued
class InProgress { status }
status: :in_progress
class Completed { commit, completed, completed_at, 3 more }
commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed: { commit, completed_at, conclusion, merge_conflict_pr}

deprecated

commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
status: :completed
install_url: String
object: :build_target
status: :not_started | :codegen | :postgen | :completed
One of the following:
:not_started
:codegen
:postgen
:completed
build: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
lint: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
test_: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
openapi: BuildTarget { commit, install_url, object, 4 more }
commit: { status} | { status} | { status} | { commit, completed, completed_at, 3 more}
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status }
status: :queued
class InProgress { status }
status: :in_progress
class Completed { commit, completed, completed_at, 3 more }
commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed: { commit, completed_at, conclusion, merge_conflict_pr}

deprecated

commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
status: :completed
install_url: String
object: :build_target
status: :not_started | :codegen | :postgen | :completed
One of the following:
:not_started
:codegen
:postgen
:completed
build: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
lint: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
test_: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
php: BuildTarget { commit, install_url, object, 4 more }
commit: { status} | { status} | { status} | { commit, completed, completed_at, 3 more}
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status }
status: :queued
class InProgress { status }
status: :in_progress
class Completed { commit, completed, completed_at, 3 more }
commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed: { commit, completed_at, conclusion, merge_conflict_pr}

deprecated

commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
status: :completed
install_url: String
object: :build_target
status: :not_started | :codegen | :postgen | :completed
One of the following:
:not_started
:codegen
:postgen
:completed
build: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
lint: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
test_: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
python: BuildTarget { commit, install_url, object, 4 more }
commit: { status} | { status} | { status} | { commit, completed, completed_at, 3 more}
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status }
status: :queued
class InProgress { status }
status: :in_progress
class Completed { commit, completed, completed_at, 3 more }
commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed: { commit, completed_at, conclusion, merge_conflict_pr}

deprecated

commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
status: :completed
install_url: String
object: :build_target
status: :not_started | :codegen | :postgen | :completed
One of the following:
:not_started
:codegen
:postgen
:completed
build: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
lint: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
test_: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
ruby: BuildTarget { commit, install_url, object, 4 more }
commit: { status} | { status} | { status} | { commit, completed, completed_at, 3 more}
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status }
status: :queued
class InProgress { status }
status: :in_progress
class Completed { commit, completed, completed_at, 3 more }
commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed: { commit, completed_at, conclusion, merge_conflict_pr}

deprecated

commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
status: :completed
install_url: String
object: :build_target
status: :not_started | :codegen | :postgen | :completed
One of the following:
:not_started
:codegen
:postgen
:completed
build: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
lint: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
test_: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
sql: BuildTarget { commit, install_url, object, 4 more }
commit: { status} | { status} | { status} | { commit, completed, completed_at, 3 more}
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status }
status: :queued
class InProgress { status }
status: :in_progress
class Completed { commit, completed, completed_at, 3 more }
commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed: { commit, completed_at, conclusion, merge_conflict_pr}

deprecated

commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
status: :completed
install_url: String
object: :build_target
status: :not_started | :codegen | :postgen | :completed
One of the following:
:not_started
:codegen
:postgen
:completed
build: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
lint: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
test_: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
terraform: BuildTarget { commit, install_url, object, 4 more }
commit: { status} | { status} | { status} | { commit, completed, completed_at, 3 more}
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status }
status: :queued
class InProgress { status }
status: :in_progress
class Completed { commit, completed, completed_at, 3 more }
commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed: { commit, completed_at, conclusion, merge_conflict_pr}

deprecated

commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
status: :completed
install_url: String
object: :build_target
status: :not_started | :codegen | :postgen | :completed
One of the following:
:not_started
:codegen
:postgen
:completed
build: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
lint: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
test_: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
typescript: BuildTarget { commit, install_url, object, 4 more }
commit: { status} | { status} | { status} | { commit, completed, completed_at, 3 more}
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status }
status: :queued
class InProgress { status }
status: :in_progress
class Completed { commit, completed, completed_at, 3 more }
commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed: { commit, completed_at, conclusion, merge_conflict_pr}

deprecated

commit: Commit { repo, sha, stats, tree_oid }
repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
completed_at: Time
conclusion: :error | :warning | :note | 9 more
One of the following:
:error
:warning
:note
:success
:merge_conflict
:upstream_merge_conflict
:fatal
:payment_required
:cancelled
:timed_out
:noop
:version_bump
merge_conflict_pr: { number, repo}
number: Float
repo: { host, name, owner}
host: String
name: String
owner: String
status: :completed
install_url: String
object: :build_target
status: :not_started | :codegen | :postgen | :completed
One of the following:
:not_started
:codegen
:postgen
:completed
build: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
lint: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
test_: CheckStep
One of the following:
class NotStarted { status }
status: :not_started
class Queued { status, url }
status: :queued
url: String
class InProgress { status, url }
status: :in_progress
url: String
class Completed { completed, conclusion, status, url }
completed: { conclusion, url}

deprecated

conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
url: String
conclusion: :success | :failure | :skipped | 4 more
One of the following:
:success
:failure
:skipped
:cancelled
:action_required
:neutral
:timed_out
status: :completed
url: String
updated_at: Time
object: :project_branch
org: String
project: String

Project name

class BranchListResponse { branch, config_commit, latest_build_id, 3 more }

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

config_commit: { repo, sha, stats, tree_oid}

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

repo: { branch, host, name, owner}
branch: String
host: String
name: String
owner: String
sha: String
stats: { additions, deletions, total}
additions: Integer
deletions: Integer
total: Integer
tree_oid: String
latest_build_id: String
object: :project_branch
org: String
project: String

Project name

untyped