View

Learn how to inspect a deployment.

Command

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

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

Parameters

The following parameters are used to configure the command:

Name	Description	Environment Variables
`org`	name of organization for the deployment	`VELA_ORG`, `DEPLOYMENT_ORG`
`repo`	name of repository for the deployment	`VELA_REPO`, `DEPLOYMENT_REPO`
`deployment`	number of the deployment	`VELA_DEPLOYMENT`, `DEPLOYMENT_NUMBER`
`output`	format the output for the deployment	`VELA_OUTPUT`, `DEPLOYMENT_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.

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 deployment --deployment 1

Targeted Request

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

Response generated from successful CLI command

id: 1
repo_id: 1
url: https://api.github.com/repos/github/octocat/deployments/1
user: octocat
commit: 48afb5bdc41ad69bf22588491333f7cf71135163
ref: main
task: deploy:vela
target: production
description: Deployment request from Vela

Examples

EXAMPLES:
  1. View deployment details for a repository.
    $ vela view deployment --org MyOrg --repo MyRepo --deployment 1
  2. View deployment details for a repository with json output.
    $ vela view deployment --org MyOrg --repo MyRepo --deployment 1 --output json
  3. View deployment details for a repository config or environment variables are set.
    $ vela view deployment --deployment 1

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