Fork me on GitHub

play2:package

Full name:

de.akquinet.innovation.play2:play2-maven-plugin:1.2.2-SNAPSHOT:package

Description:

Package the Play application. The application is packaged as a Jar file. It is also possible to create the distribution package (zip).

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: package.

Optional Parameters

Name Type Since Description
additionalFiles List - Allows customization of the play packaging. The files specified in this attribute will get added to the distribution zip file. This allows, for example, to write your own start script and have it packaged in the distribution. This is done post-packaging by the play framework.
attachDist boolean - Enables or disables the attachment of the distribution file as an artifact to this project. This option has no impact if the distribution is not built.
Default value is: true.
attachJavadoc boolean - Enables or disables the attachment of the -javadoc artifact. This artifact is created during the play distribution packaging process. If set to true, and if the artifact is not found, the build fails.
Default value is: false.
attachSources boolean - Enables or disables the attachment of the -source artifact. This artifact is created during the play distribution packaging process. If set to true, and if the artifact is not found, the build fails.
Default value is: false.
baseDirectory File - Base directory of the project.
buildDirectory File - Directory containing the build files.
buildDist boolean - Enables or disables the packaging of the whole distribution. The distribution is an autonomous archive containing all the files required to run the play application. Play 2 module can disable the distribution packaging.
Default value is: true.
classifier String - Output file classifier.
deleteDist boolean - Enables or disables the deletion of the dist folder after having packaged the application and copied the distribution file to target. It allows keeping the base directory cleaner.
Default value is: true.
play2Home String - The PLAY2_HOME path is taken from this setting, if not found as a Java system property (-DPLAY2_HOME). Refers to the PLAY2_HOME environment variable by default. So that means that the PLAY2_HOME can be given using:
  1. A system variable defined by the system or with -DPLAY2_HOME=...
  2. The play2Home configuration property
  3. The PLAY2_HOME environment property
play2SystemProperties Properties - Allows customization of the play execution System properties.
timeout long - Sets a timeout to the play invocation (in milliseconds). If not set (or set to -1, the plugin waits until the underlying play process completes. If set, the plugin kills the underlying play process when the timeout is reached, and it fails the build.
Default value is: -1.

Parameter Details

additionalFiles:

Allows customization of the play packaging. The files specified in this attribute will get added to the distribution zip file. This allows, for example, to write your own start script and have it packaged in the distribution. This is done post-packaging by the play framework.
  • Type: java.util.List
  • Required: No

attachDist:

Enables or disables the attachment of the distribution file as an artifact to this project. This option has no impact if the distribution is not built.
  • Type: boolean
  • Required: No
  • Default: true

attachJavadoc:

Enables or disables the attachment of the -javadoc artifact. This artifact is created during the play distribution packaging process. If set to true, and if the artifact is not found, the build fails.
  • Type: boolean
  • Required: No
  • Default: false

attachSources:

Enables or disables the attachment of the -source artifact. This artifact is created during the play distribution packaging process. If set to true, and if the artifact is not found, the build fails.
  • Type: boolean
  • Required: No
  • Default: false

baseDirectory:

Base directory of the project.
  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}

buildDirectory:

Directory containing the build files.
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}

buildDist:

Enables or disables the packaging of the whole distribution. The distribution is an autonomous archive containing all the files required to run the play application. Play 2 module can disable the distribution packaging.
  • Type: boolean
  • Required: No
  • Default: true

classifier:

Output file classifier.
  • Type: java.lang.String
  • Required: No

deleteDist:

Enables or disables the deletion of the dist folder after having packaged the application and copied the distribution file to target. It allows keeping the base directory cleaner.
  • Type: boolean
  • Required: No
  • Default: true

play2Home:

The PLAY2_HOME path is taken from this setting, if not found as a Java system property (-DPLAY2_HOME). Refers to the PLAY2_HOME environment variable by default. So that means that the PLAY2_HOME can be given using:
  1. A system variable defined by the system or with -DPLAY2_HOME=...
  2. The play2Home configuration property
  3. The PLAY2_HOME environment property
  • Type: java.lang.String
  • Required: No
  • Expression: ${env.PLAY2_HOME}

play2SystemProperties:

Allows customization of the play execution System properties.
  • Type: java.util.Properties
  • Required: No

timeout:

Sets a timeout to the play invocation (in milliseconds). If not set (or set to -1, the plugin waits until the underlying play process completes. If set, the plugin kills the underlying play process when the timeout is reached, and it fails the build.
  • Type: long
  • Required: No
  • Expression: ${play2timeout}
  • Default: -1