Play! 2.x Maven Plugin

play2:dist

Full name:

com.google.code.play2-maven-plugin:play2-maven-plugin:1.0.0-rc5:dist

Description:

Package Play! framework and Play! application as one zip achive (standalone distribution).

Attributes:

Requires a Maven project to be executed.
Requires dependency resolution of artifacts in scope: runtime.
Since version: 1.0.0.
Binds by default to the lifecycle phase: package.

Required Parameters

Name	Type	Since	Description
`<distArchiveName>`	`String`	`1.0.0`	The name of the generated distribution file. Default value is: `${project.build.finalName}`. User property is: `play2.distArchiveName`.
`<distOutputDirectory>`	`String`	`1.0.0`	The directory for the generated distribution file. Default value is: `${project.build.directory}`. User property is: `play2.distOutputDirectory`.

Optional Parameters

Name	Type	Since	Description
`<distAttach>`	`boolean`	`1.0.0`	Attach generated distribution file to project artifacts. Default value is: `false`. User property is: `play2.distAttach`.
`<distClassifier>`	`String`	`1.0.0`	Classifier to add to the generated distribution file. Default value is: `dist`. User property is: `play2.distClassifier`.
`<distClassifierIncludes>`	`String`	`1.0.0`	Distribution additional project artifacts include filter. Comma-separated list of the classifiers of project's additional artifacts to include. For example `assets` value means that `target/${artifactId}-${version}-assets.jar` will be added to `lib` directory in distribution archive. User property is: `play2.distClassifierIncludes`.
`<distDependencyExcludes>`	`String`	`1.0.0`	Distribution dependency exclude filter. User property is: `play2.distDependencyExcludes`.
`<distDependencyIncludes>`	`String`	`1.0.0`	Distribution dependency include filter. User property is: `play2.distDependencyIncludes`.
`<distFormats>`	`String`	`1.0.0`	Distribution archive formats. Comma-separated list of archive formats to generate. Supported formats: `zip` `jar` `tar` `tar.bz2`, `tbz2` `tar.gz`, `tgz` `tar.snappy` `tar.xz`, `txz` Default value is: `zip`. User property is: `play2.distFormats`.
`<distSkip>`	`boolean`	`1.0.0`	Skip distribution file generation. Default value is: `false`. User property is: `play2.distSkip`.
`<distTarLongFileMode>`	`String`	`1.0.0`	Sets the tar archiver behavior on file paths more than 100 characters long. Valid values: `warn` - GNU extensions are used with warning `gnu` - GNU extensions are used without warning `posix_warn` - POSIX extensions are used with warning `posix` - POSIX extensions are used without warning `truncate` - paths are truncated to the maximum length `omit` - paths are omitted from the archive `fail` - build fails Default value is: `warn`. User property is: `play2.distTarLongFileMode`.
`<distTopLevelDirectory>`	`String`	`1.0.0`	Distribution top level directory. Default value is: `${project.build.finalName}`. User property is: `play2.distTopLevelDirectory`.
`<mainModule>`	`String`	`1.0.0`	Identifier of the module to prepare the distribution for. Important in multi-module projects with more than one `play2` modules to select for which one to prepare the distribution. There are three supported formats: `artifactId` or `:artifactId` - find first module with given `artifactId` `groupId:artifactId` - find module with given `groupId` and `artifactId` If not specified, all reactor modules with `play2` packaging will be selected. User property is: `play2.mainModule`.
`<playVersion>`	`String`	`1.0.0`	Used to automatically select one of the "well known" Play! providers if no provider added explicitly as plugin's dependency. User property is: `play2.version`.
`<prodSettings>`	`String`	`1.0.0`	Extra settings used only in production mode (like `devSettings` for development mode). Space-separated list of key=value pairs, e.g. `play.server.http.port=9001 play.server.https.port=9443` User property is: `play2.prodSettings`.
`<serverJvmArgs>`	`String`	`1.0.0`	Additional JVM arguments passed to Play! server's JVM Space-separated list of arguments, e.g. `-Xmx1024m -Dconfig.resource=application-prod.conf -Dlogger.file=./conf/logback-prod.xml` User property is: `play2.serverJvmArgs`.

Parameter Details

<distArchiveName>

The name of the generated distribution file.

Type: java.lang.String
Since: 1.0.0
Required: Yes
User Property: play2.distArchiveName
Default: ${project.build.finalName}

<distAttach>

Attach generated distribution file to project artifacts.

Type: boolean
Since: 1.0.0
Required: No
User Property: play2.distAttach
Default: false

<distClassifier>

Classifier to add to the generated distribution file.

Type: java.lang.String
Since: 1.0.0
Required: No
User Property: play2.distClassifier
Default: dist

Distribution additional project artifacts include filter. Comma-separated list of the classifiers of project's additional artifacts to include. For example assets value means that target/${artifactId}-${version}-assets.jar will be added to lib directory in distribution archive.

Type: java.lang.String
Since: 1.0.0
Required: No
User Property: play2.distClassifierIncludes

<distDependencyExcludes>

Distribution dependency exclude filter.

Type: java.lang.String
Since: 1.0.0
Required: No
User Property: play2.distDependencyExcludes

<distDependencyIncludes>

Distribution dependency include filter.

Type: java.lang.String
Since: 1.0.0
Required: No
User Property: play2.distDependencyIncludes

<distFormats>

Distribution archive formats.

Comma-separated list of archive formats to generate.
Supported formats:

zip
jar
tar
tar.bz2, tbz2
tar.gz, tgz
tar.snappy
tar.xz, txz

Type: java.lang.String
Since: 1.0.0
Required: No
User Property: play2.distFormats
Default: zip

<distOutputDirectory>

The directory for the generated distribution file.

Type: java.lang.String
Since: 1.0.0
Required: Yes
User Property: play2.distOutputDirectory
Default: ${project.build.directory}

<distSkip>

Skip distribution file generation.

Type: boolean
Since: 1.0.0
Required: No
User Property: play2.distSkip
Default: false

<distTarLongFileMode>

Sets the tar archiver behavior on file paths more than 100 characters long.
Valid values:

warn - GNU extensions are used with warning
gnu - GNU extensions are used without warning
posix_warn - POSIX extensions are used with warning
posix - POSIX extensions are used without warning
truncate - paths are truncated to the maximum length
omit - paths are omitted from the archive
fail - build fails

Type: java.lang.String
Since: 1.0.0
Required: No
User Property: play2.distTarLongFileMode
Default: warn

<distTopLevelDirectory>

Distribution top level directory.

Type: java.lang.String
Since: 1.0.0
Required: No
User Property: play2.distTopLevelDirectory
Default: ${project.build.finalName}

<mainModule>

Identifier of the module to prepare the distribution for.

Important in multi-module projects with more than one play2 modules to select for which one to prepare the distribution.
There are three supported formats:

artifactId or :artifactId - find first module with given artifactId
groupId:artifactId - find module with given groupId and artifactId

If not specified, all reactor modules with play2 packaging will be selected.

Type: java.lang.String
Since: 1.0.0
Required: No
User Property: play2.mainModule

<playVersion>

Used to automatically select one of the "well known" Play! providers if no provider added explicitly as plugin's dependency.

Type: java.lang.String
Since: 1.0.0
Required: No
User Property: play2.version

<prodSettings>

Extra settings used only in production mode (like devSettings for development mode).

Space-separated list of key=value pairs, e.g.
play.server.http.port=9001 play.server.https.port=9443

Type: java.lang.String
Since: 1.0.0
Required: No
User Property: play2.prodSettings

<serverJvmArgs>

Additional JVM arguments passed to Play! server's JVM

Space-separated list of arguments, e.g.
-Xmx1024m -Dconfig.resource=application-prod.conf -Dlogger.file=./conf/logback-prod.xml

Type: java.lang.String
Since: 1.0.0
Required: No
User Property: play2.serverJvmArgs