Cancel
Learn how to cancel a build.
Command
$ vela cancel build <parameters...>
For more information, you can run
vela cancel 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 cancel build --build 1
Targeted Request
$ vela cancel build --org github --repo octocat --build 1
Response
canceled build github/octocat/1
Last modified February 9, 2022: chore(CLI): add documentation for CLI repo awareness (#272) (8e9eb4ce)