Fork me on GitHub

application:upload

Full name:

net.oneandone.maven.plugins:application:1.6.3-SNAPSHOT:upload

Description:

Copies an application to some target directory and creates/updates a symlink pointing to it. The symlink is mandatory, because it allows version updates without breaking running applications. So it's not possible to only install the application file with this plugin.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.

Required Parameters

Name Type Since Description
symlink String - Symlink pointing to the application. A local file or an ssh location

Optional Parameters

Name Type Since Description
classifier String - Classifier to deploy application files with. Specify a different value if you want to deploy multiple applications.
Default value is: application.
dir FileNode - Directory where to place the Launch Script and the executable Jar file. Usually, there's no need to change the default value, which is target.
Default value is: ${project.build.directory}.
name String - Name for the generated application file.
Default value is: ${project.artifactId}.
permissions String - Permissions for application file.
Default value is: rwxr-xr-x.
resolve String - Version of the application artifact to resolve from Maven repositories. When not specified, the artifact is picked from the build directory. This is useful to test local builds.
User property is: resolve.
skipSymlink boolean - Skip symlink update. Useful if you just need a new target file uploaded, but don't want everybody to use it.
Default value is: false.
User property is: skipSymlink.
target String - Directory where to store application. A local directory or an ssh location. Optional, when not specified, the directory containing the symlink will be used. The name of the application in the target file is artifactId + "-" + Strings.removeRightOpt(version, "-SNAPSHOT") + "-" + classifier + "." + type);artifactId . Note that snapshot suffixes are stripped, i.e. updating an snapshot overwrites the previous snapshots.
type String - Type to deploy application files with.
Default value is: sh.
uploadPermissions boolean - Set permissions of uploaded file?
Default value is: true.

Parameter Details

classifier:

Classifier to deploy application files with. Specify a different value if you want to deploy multiple applications.
  • Type: java.lang.String
  • Required: No
  • Default: application

dir:

Directory where to place the Launch Script and the executable Jar file. Usually, there's no need to change the default value, which is target.
  • Type: net.oneandone.sushi.fs.file.FileNode
  • Required: No
  • Default: ${project.build.directory}

name:

Name for the generated application file.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.artifactId}

permissions:

Permissions for application file.
  • Type: java.lang.String
  • Required: No
  • Default: rwxr-xr-x

resolve:

Version of the application artifact to resolve from Maven repositories. When not specified, the artifact is picked from the build directory. This is useful to test local builds.
  • Type: java.lang.String
  • Required: No
  • User Property: resolve

skipSymlink:

Skip symlink update. Useful if you just need a new target file uploaded, but don't want everybody to use it.
  • Type: boolean
  • Required: No
  • User Property: skipSymlink
  • Default: false

symlink:

Symlink pointing to the application. A local file or an ssh location
  • Type: java.lang.String
  • Required: Yes

target:

Directory where to store application. A local directory or an ssh location. Optional, when not specified, the directory containing the symlink will be used. The name of the application in the target file is artifactId + "-" + Strings.removeRightOpt(version, "-SNAPSHOT") + "-" + classifier + "." + type);artifactId . Note that snapshot suffixes are stripped, i.e. updating an snapshot overwrites the previous snapshots.
  • Type: java.lang.String
  • Required: No

type:

Type to deploy application files with.
  • Type: java.lang.String
  • Required: No
  • Default: sh

uploadPermissions:

Set permissions of uploaded file?
  • Type: boolean
  • Required: No
  • Default: true