Assemble an application bundle or distribution from an assembly descriptor into the
target directory structure but do not generate the final archive. This goal is suitable
for using at the root of a multimodule project, and is the unarchived counterpart to assembly:attached.
Mojo Attributes :
| Name | Type | Description |
|---|---|---|
| finalName | String |
The filename of the assembled distribution file. Default value is ${project.build.finalName}. |
| outputDirectory | File |
The output directory of the assembled distribution file. Default value is ${project.build.directory}. |
| workDirectory | File |
Directory to unpack JARs into if needed Default value is ${project.build.directory}/assembly/work. |
| Name | Type | Description |
|---|---|---|
| appendAssemblyId | boolean |
Set to false to exclude the assembly id from the assembly final name. Default value is true. |
| archive | MavenArchiveConfiguration |
This is a set of instructions to the archive builder, especially for building .jar files. It enables you to specify a Manifest file for the jar, in addition to other options. |
| archiveBaseDirectory | File |
This is the base directory from which archive files are created.
This base directory pre-pended to any <directory>
specifications in the assembly descriptor. This is an optional
parameter. |
| assemblyArchiver | AssemblyArchiver |
No description. |
| assemblyReader | AssemblyReader |
No description. |
| attach | boolean |
Controls whether the assembly plugin tries to attach the resulting
assembly to the project. Default value is true. |
| classifier | String |
This is the artifact classifier to be used for the resultant assembly artifact. Normally, you would use the assembly-id instead of specifying this here. |
| descriptor | String |
Assembly XML Descriptor file. This must be the path to your customized descriptor file. |
| descriptorId | String |
Predefined Assembly Descriptor Id's. You can select bin, jar-with-dependencies, or src. |
| descriptorRefs | String[] |
A list of built-in descriptor references to generate from. You can select from bin,
jar-with-dependencies, or src. |
| descriptorSourceDirectory | File |
Directory to scan for descriptor files in. |
| descriptors | String[] |
A list of descriptor files to generate from. |
| dryRun | boolean |
If this flag is set, everything up to the call to Archiver.createArchive() will be executed. Default value is false. |
| filters | List |
No description. |
| ignoreDirFormatExtensions | boolean |
If this flag is set, the ".dir" suffix will be suppressed in the output
directory name when using assembly/format == 'dir' and other formats
that begin with 'dir'. Default value is false. |
| ignoreMissingDescriptor | boolean |
Set to true in order to not fail when a descriptor is missing. Default value is false. |
| includeSite | boolean |
Set to true to include the site generated by site:site goal. Default value is false. |
| projectHelper | MavenProjectHelper |
Maven ProjectHelper. |
| skipAssembly | boolean |
Flag allowing one or more executions of the assembly plugin to be configured
as skipped for a particular build. This makes the assembly plugin more controllable
from profiles. Default value is false. |
| tarLongFileMode | String |
Sets the TarArchiver behavior on file paths with more than 100 characters length.
Valid values are: "warn" (default), "fail", "truncate", "gnu", or "omit". Default value is warn. |
Set to false to exclude the assembly id from the assembly final name.
booleanNo${appendAssemblyId}trueThis is a set of instructions to the archive builder, especially for building .jar files. It enables you to specify a Manifest file for the jar, in addition to other options.
org.apache.maven.archiver.MavenArchiveConfigurationNoThis is the base directory from which archive files are created.
This base directory pre-pended to any <directory>
specifications in the assembly descriptor. This is an optional
parameter.
java.io.FileNoNo Description.
org.apache.maven.plugin.assembly.archive.AssemblyArchiverNoNo Description.
org.apache.maven.plugin.assembly.io.AssemblyReaderNoControls whether the assembly plugin tries to attach the resulting assembly to the project.
boolean2.2-beta-1No${attach}trueThis is the artifact classifier to be used for the resultant assembly artifact. Normally, you would use the assembly-id instead of specifying this here.
java.lang.StringNo${classifier}Assembly XML Descriptor file. This must be the path to your customized descriptor file.
java.lang.StringNo${descriptor}Predefined Assembly Descriptor Id's. You can select bin, jar-with-dependencies, or src.
java.lang.StringNo${descriptorId}A list of built-in descriptor references to generate from. You can select from bin,
jar-with-dependencies, or src.
java.lang.String[]NoDirectory to scan for descriptor files in.
java.io.FileNoA list of descriptor files to generate from.
java.lang.String[]NoIf this flag is set, everything up to the call to Archiver.createArchive() will be executed.
booleanNo${assembly.dryRun}falseNo Description.
java.util.ListNoThe filename of the assembled distribution file.
java.lang.StringYes${project.build.finalName}If this flag is set, the ".dir" suffix will be suppressed in the output directory name when using assembly/format == 'dir' and other formats that begin with 'dir'.
booleanNofalseSet to true in order to not fail when a descriptor is missing.
booleanNo${ignoreMissingDescriptor}falseSet to true to include the site generated by site:site goal.
booleanNo${includeSite}falseThe output directory of the assembled distribution file.
java.io.FileYes${project.build.directory}Maven ProjectHelper.
org.apache.maven.project.MavenProjectHelperNoFlag allowing one or more executions of the assembly plugin to be configured as skipped for a particular build. This makes the assembly plugin more controllable from profiles.
booleanNofalseSets the TarArchiver behavior on file paths with more than 100 characters length. Valid values are: "warn" (default), "fail", "truncate", "gnu", or "omit".
java.lang.StringNo${tarLongFileMode}warnDirectory to unpack JARs into if needed
java.io.FileYes${project.build.directory}/assembly/work