assembly:assembly

Assemble an application bundle or distribution from an assembly descriptor.

Mojo Attributes:

  • Requires a Maven 2.0 project to execute.
  • Executes as an aggregator plugin.
  • Requires dependency resolution of artifacts in scope: test
  • Invokes the execution of the lifecycle phase package prior to executing itself.

Required Parameters

Name Type Description
finalName String The filename of the assembled distribution file.
outputDirectory File The output directory of the assembled distribution file.
workDirectory File Directory to unpack JARs into if needed

Optional Parameters

Name Type Description
appendAssemblyId boolean Set to false to exclude the assembly id from the assembly final name. Default value is true.
archive MavenArchiveConfiguration No description.
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
artifactResolver ArtifactResolver No description.
classifier String No description.
descriptor File 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 File[] A list of descriptor files to generate from.
executedProject MavenProject Get the executed project from the forked lifecycle.
filters List No description.
includeSite boolean Set to true to include the site generated by site:site goal. Default value is false.
localRepository ArtifactRepository No description.
projectHelper MavenProjectHelper Maven ProjectHelper
repositoryAssembler RepositoryAssembler No description.
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.

Parameter Details

appendAssemblyId Set to false to exclude the assembly id from the assembly final name.
  • Type: boolean
  • Required: No
  • Expression: ${appendAssemblyId}
  • Default: true

archive No Description.
  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Required: No

archiveBaseDirectory 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
  • Type: java.io.File
  • Required: No

artifactResolver No Description.
  • Type: org.apache.maven.artifact.resolver.ArtifactResolver
  • Required: No

classifier No Description.
  • Type: java.lang.String
  • Required: No
  • Expression: ${classifier}

descriptor Assembly XML Descriptor file. This must be the path to your customized descriptor file.
  • Type: java.io.File
  • Required: No
  • Expression: ${descriptor}

descriptorId Predefined Assembly Descriptor Id's. You can select bin, jar-with-dependencies, or src.
  • Type: java.lang.String
  • Required: No
  • Expression: ${descriptorId}

descriptorRefs A list of built-in descriptor references to generate from. You can select from bin, jar-with-dependencies, or src.
  • Type: java.lang.String[]
  • Required: No

descriptorSourceDirectory directory to scan for descriptor files in
  • Type: java.io.File
  • Required: No

descriptors A list of descriptor files to generate from.
  • Type: java.io.File[]
  • Required: No

executedProject Get the executed project from the forked lifecycle.
  • Type: org.apache.maven.project.MavenProject
  • Required: No
  • Expression: ${executedProject}

filters No Description.
  • Type: java.util.List
  • Required: No
  • Expression: ${project.build.filters}

finalName The filename of the assembled distribution file.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${project.build.finalName}

includeSite Set to true to include the site generated by site:site goal.
  • Type: boolean
  • Required: No
  • Expression: ${includeSite}
  • Default: false

localRepository No Description.
  • Type: org.apache.maven.artifact.repository.ArtifactRepository
  • Required: No
  • Expression: ${localRepository}

outputDirectory The output directory of the assembled distribution file.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}

projectHelper Maven ProjectHelper
  • Type: org.apache.maven.project.MavenProjectHelper
  • Required: No

repositoryAssembler No Description.
  • Type: org.apache.maven.plugin.assembly.repository.RepositoryAssembler
  • Required: No

tarLongFileMode Sets the TarArchiver behavior on file paths with more than 100 characters length. Valid values are: "warn" (default), "fail", "truncate", "gnu", or "omit".
  • Type: java.lang.String
  • Required: No
  • Expression: ${tarLongFileMode}
  • Default: warn

workDirectory Directory to unpack JARs into if needed
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/assembly/work