Validate

Learn how to validate a Vela pipeline.

Command

$ vela validate pipeline <parameters...> <arguments...>

For more information, please run vela validate pipeline --help.

The following parameters are used to configure the command:

Name	Description	Environment Variables
`file`	name of the file for the pipeline	`VELA_FILE`, `PIPELINE_FILE`
`path`	path to the file for the pipeline	`VELA_PATH`, `PIPELINE_PATH`
`ref`	repository reference for the pipeline	`VELA_REF`, `PIPELINE_REF`
`template`	enables templates to be included in pipeline validation	`VELA_TEMPLATE`, `PIPELINE_TEMPLATE`
`template-file`	enables using a local template file for expansion	`VELA_TEMPLATE_FILE`, `PIPELINE_TEMPLATE_FILE`
`remote`	enables validating a pipeline on a remote server	`VELA_REMOTE`, `PIPELINE_REMOTE`
`compiler.github.token`	github compiler token	`VELA_COMPILER_GITHUB_TOKEN`, `COMPILER_GITHUB_TOKEN`
`compiler.github.url`	github url, used by compiler, for pulling registry templates	`VELA_COMPILER_GITHUB_URL`, `COMPILER_GITHUB_URL`

COMING SOON!

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.

vela validate pipeline

vela validate pipeline --template --compiler.github.token <token> --compiler.github.url https://git.example.com

vela validate pipeline --template --template-file name:/path/to/file

".vela.yml" is valid

Using a template in your pipeline? You can validate templates also.