Skip to main content

View

Command

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

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

Parameters

The following parameters are used to configure the command:

NameDescriptionEnvironment Variables
orgname of organization for the buildVELA_ORG, BUILD_ORG
reponame of repository for the buildVELA_REPO, BUILD_REPO
buildnumber of the buildVELA_BUILD, BUILD_NUMBER
outputformat the output for the buildVELA_OUTPUT, BUILD_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 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"