Skip to main content

View

Command

$ vela view step <parameters...> <arguments...>
tip

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

Parameters

The following parameters are used to configure the command:

NameDescriptionEnvironment Variables
orgname of organization for the stepVELA_ORG, STEP_ORG
reponame of repository for the stepVELA_REPO, STEP_REPO
buildnumber of build for the stepVELA_BUILD, STEP_BUILD
stepnumber of the stepVELA_STEP, STEP_NUMBER
outputformat the output for the stepVELA_OUTPUT, STEP_OUTPUT
tip

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

warning

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 step --build 1 --step 1

Targeted Request

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

Response

id: 1
build_id: 1
repo_id: 1
number: 1
name: clone
status: success
error: "" # Populates when the platform runs into an error with the build
exitcode: 0
created: 1561748980
started: 1561748979
finished: 1561748981
host: "worker.host.com"
runtime: "docker"
distribution: "linux"