Fork me on GitHub

play2:package

Full name:

de.akquinet.innovation.play2:play2-maven-plugin:1.2.1: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
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.
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
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

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

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}

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