Fork me on GitHub

play2:clean

Full name:

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

Description:

Clean the project.

Attributes:

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

Optional Parameters

Name Type Since Description
baseDirectory File - Base directory of the project.
buildDirectory File - Directory containing the build files.
cleanLibFolder boolean - Set to false to avoid to clean the lib folder..
Default value is: true.
lib File - Where are the dependencies copied.
Default value is: lib.
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

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}

cleanLibFolder:

Set to false to avoid to clean the lib folder..
  • Type: boolean
  • Required: No
  • Default: true

lib:

Where are the dependencies copied.
  • Type: java.io.File
  • Required: No
  • Default: lib

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