we:deploy

Full name:

com.commsen.wedeploy:wedeploy-maven-plugin:0.1.0:deploy

Description:

Deploys a set of files to given WeDeploy project.

Attributes:

  • Requires a Maven project to be executed.
  • Executes by direct invocation only.
  • Binds by default to the lifecycle phase: install.
  • Requires that Maven runs in online mode.

Required Parameters

Name Type Since Description
project String - Name of the WeDeploy project.
User property is: wedeploy.project.
sourceDirectory File - Location of the directory containing files to deploy. It must contain wedeploy.json file which provides WeDeploy with the name of the service and deployment parameters (see https://wedeploy.com/docs/deploy/getting-started/) for details!
Default value is: ${project.basedir}/src/wedeploy.
User property is: wedeploy.source.directory.
targetDirectory File - Location of the directory where files from DeployMojo.sourceDirectory directory will be merged with files in DeployMojo.includes! The result is what gets deployed.
Default value is: ${project.build.directory}/wedeploy.
User property is: wedeploy.output.directory.

Optional Parameters

Name Type Since Description
dryrun boolean - Merge the files in DeployMojo.targetDirectory but do not deploy them.
Default value is: false.
User property is: wedeploy.dryrun.
includes List - Additional (likely generated) files to be deployed.
User property is: wedeploy.includes.
password String - WeDeploy password.
User property is: wedeploy.password.
serverId String - The id of the server section in settings.xml that contains WeDeploy credentials.
User property is: wedeploy.serverId.
user String - WeDeploy user.
User property is: wedeploy.user.

Parameter Details

dryrun:

Merge the files in DeployMojo.targetDirectory but do not deploy them.
  • Type: boolean
  • Required: No
  • User Property: wedeploy.dryrun
  • Default: false

includes:

Additional (likely generated) files to be deployed.
  • Type: java.util.List
  • Required: No
  • User Property: wedeploy.includes

password:

WeDeploy password.
  • Type: java.lang.String
  • Required: No
  • User Property: wedeploy.password

project:

Name of the WeDeploy project.
  • Type: java.lang.String
  • Required: Yes
  • User Property: wedeploy.project

serverId:

The id of the server section in settings.xml that contains WeDeploy credentials.
  • Type: java.lang.String
  • Required: No
  • User Property: wedeploy.serverId

sourceDirectory:

Location of the directory containing files to deploy. It must contain wedeploy.json file which provides WeDeploy with the name of the service and deployment parameters (see https://wedeploy.com/docs/deploy/getting-started/) for details!
  • Type: java.io.File
  • Required: Yes
  • User Property: wedeploy.source.directory
  • Default: ${project.basedir}/src/wedeploy

targetDirectory:

Location of the directory where files from DeployMojo.sourceDirectory directory will be merged with files in DeployMojo.includes! The result is what gets deployed.
  • Type: java.io.File
  • Required: Yes
  • User Property: wedeploy.output.directory
  • Default: ${project.build.directory}/wedeploy

user:

WeDeploy user.
  • Type: java.lang.String
  • Required: No
  • User Property: wedeploy.user