vb-deploy

This task deploys a visual application to a Visual Builder runtime instance.

You must build visual applications using the vb-process-local task before you use the vb-deploy task.

The following table describes the subtasks, hooks and inputs and outputs of the vb-deploy task:

Detail Description
subtasks n/a
multitask n/a
hooks n/a
input build/processed/*, build/optimized/*
output build/deploy.zip

The following tables describe the options for a visual application when using the vb-deploy task.

Application selection task options for visual applications

Name Mandatory Default Value Description
id yes Read from the rootURL attribute in visual-application.json ID of the visual application you're going to build.
ver yes Read from version attribute in visual-application.json Version of the visual application.
url[:rt] yes n/a

A Visual Builder runtime service URL.

The rt suffix is optional.

profileId no n/a Application profile ID.
remoteProjectId no n/a ID of the source project in VB Studio.
remoteGitRepo no n/a URL of the source Git repository in VB Studio.

Visual application authentication options

Name Mandatory Default Value Description
username[:rt] no n/a The username to be used to obtain OAuth access token for further communication with Visual Builder runtime.

The rt suffix is optional.

password[:rt] no n/a The password to be used to obtain OAuth access token for further communication with Visual Builder runtime.

The rt suffix is optional.

A password specified via the --password Grunt option may need to be enclosed in single quotation marks (') if it contains special characters. In general, it's advisable to always use quotation marks for the --password option, especially in VB Studio jobs where the password is provided via a job variable. For example: grunt vb-deploy '--password=Jkl@#&!%^23' ....

accessToken[:rt] no n/a The value of OAuth access token. If provided, username and password options are not necessary.

The rt suffix is optional.

sslCertificate[:rt] no n/a The path to the SSL certificate for the connection to Visual Builder instances provisioned with self-signed certificates.

The rt suffix is optional.

Visual application build options

Name Mandatory Default Value Description
target no build Name of build directory.

Visual application data processing options

Name Mandatory Default Value Description
schema no new Specifies data schema processing during application stage or publish. The value can be:
  • new to create a new data schema

  • dev to use the data schema from development

  • stage to use the data schema from the previous staged version of the application

  • live to use the data schema from the previous live version of the application

Other options for visual applications

Name Mandatory Default Value Description
publish no false Defines whether the deployed application should be published or not.