View

Learn how to inspect a build.

Command

$ vela view build <parameters...> <arguments...>

For more information, you can run vela view build --help.

Parameters

The following parameters are used to configure the command:

Name	Description	Environment Variables
`org`	name of organization for the build	`VELA_ORG`, `BUILD_ORG`
`repo`	name of repository for the build	`VELA_REPO`, `BUILD_REPO`
`build`	number of the build	`VELA_BUILD`, `BUILD_NUMBER`
`output`	format the output for the build	`VELA_OUTPUT`, `BUILD_OUTPUT`

This command also supports setting the following parameters via a configuration file:

org
repo
output

For more information, please review the CLI config documentation.

Permissions

COMING SOON!

Sample

This section assumes you have already installed and setup the CLI.

To install the CLI, please review the installation documentation.

To setup the CLI, please review the authentication documentation.

Request

$ pwd
~/github/octocat
$ vela view build --build 1

Targeted Request

$ vela view build --org github --repo octocat --build 1

Response

id: 1
repo_id: 1
number: 1
parent: 1
event: push
status: created
error: ""               # Populates when the platform runs into an error with the build
enqueued: 1563474077
created: 1563474076
started: 1563474077
finished: 0
deploy: ""
clone: https://github.com/github/octocat.git
source: https://github.com/github/octocat/commit/48afb5bdc41ad69bf22588491333f7cf71135163
title: push received from https://github.com/github/octocat
message: First commit...
commit: 48afb5bdc41ad69bf22588491333f7cf71135163
sender: OctoKitty
author: OctoKitty
branch: main
ref: refs/heads/main
baseref: ""
host: "company.localhost"
runtime: "docker"
distribution: "linux"

Last modified September 16, 2022: chore: use main as default (#324) (400aa851)