1.0.0+
An assembly defines a collection of files usually distributed in an
archive format such as zip, tar, or tar.gz that is generated from a
project. For example, a project could produce a ZIP assembly which
contains a project's JAR artifact in the root directory, the
runtime dependencies in a lib/ directory, and a shell script to launch
a stand-alone application.
1.0.0+
An assembly defines a collection of files usually distributed in an
archive format such as zip, tar, or tar.gz that is generated from a
project. For example, a project could produce a ZIP assembly which
contains a project's JAR artifact in the root directory, the
runtime dependencies in a lib/ directory, and a shell script to launch
a stand-alone application.
1.0.0+
Sets the id of this assembly. This is a symbolic name for a
particular assembly of files from this project. Also, aside from
being used to distinctly name the assembled package by attaching
its value to the generated archive, the id is used as your
artifact's classifier when deploying.
1.0.0+
Specifies the formats of the assembly.
It is often better to specify the formats via the goal parameter rather
than here. For example, that allows different profiles to generate
different types of archives.
Multiple formats can be
supplied and the Assembly Plugin will generate an archive for each
of the desired formats. When deploying your project, all file formats
specified will also be deployed. A format is specified by supplying
one of the following values in a <format> subelement:
<ul>
<li><b>"zip"</b> - Creates a ZIP file format</li>
<li><b>"tar"</b> - Creates a TAR format</li>
<li><b>"tar.gz"</b> or <b>"tgz"</b> - Creates a gzip'd TAR format</li>
<li><b>"tar.bz2"</b> or <b>"tbz2"</b> - Creates a bzip'd TAR format</li>
<li><b>"jar"</b> - Creates a JAR format</li>
<li><b>"dir"</b> - Creates an exploded directory format</li>
<li><b>"war"</b> - Creates a WAR format</li>
</ul>
0.0.0+
Includes a base directory in the final archive. For example,
if you are creating an assembly named "your-app", setting
includeBaseDirectory to true will create an archive that
includes this base directory. If this option is set to false
the archive created will unzip its content to the current
directory.
1.1.0+
Sets the base directory of the resulting assembly archive. If this is not
set and includeBaseDirectory == true, ${project.build.finalName} will be used instead.
(Since 2.2-beta-1)
0.0.0+
Includes a site directory in the final archive. The site directory
location of a project is determined by the siteDirectory parameter
of the Assembly Plugin.
1.1.0+
Set of components which filter various container descriptors out of
the normal archive stream, so they can be aggregated then added.
1.0.0+
Specifies which module files to include in the assembly. A moduleSet
is specified by providing one or more of <moduleSet>
subelements.
1.0.0+
Specifies which groups of files to include in the assembly. A
fileSet is specified by providing one or more of <fileSet>
subelements.
1.0.0+
Specifies which single files to include in the assembly. A file
is specified by providing one or more of <file>
subelements.
1.0.0+
Specifies which dependencies to include in the assembly. A
dependencySet is specified by providing one or more of
<dependencySet> subelements.
1.0.0+
Specifies which repository files to include in the assembly. A
repository is specified by providing one or more of
<repository> subelements.
1.0.0+
Specifies the shared components xml file locations to include in the
assembly. The locations specified must be relative to the base location
of the descriptor. If the descriptor was found via a <descriptorRef/>
element in the
classpath, any components it specifies will also be found on the classpath.
If it is found by pathname via a <descriptor/> element
the value here will be interpreted
as a path relative to the project basedir.
When multiple componentDescriptors are found, their
contents are merged. Check out the <a href="component.html">
descriptor components</a> for more information. A
componentDescriptor is specified by providing one or more of
<componentDescriptor> subelements.
1.0.0+
A file allows individual file inclusion with the option to change
the destination filename not supported by fileSets.
1.0.0+
Sets the absolute or relative path from the module's directory
of the file to be included in the assembly.
1.0.0+
Sets the output directory relative to the root
of the root directory of the assembly. For example,
"log" will put the specified files in the log directory.
1.0.0+
Sets the destination filename in the outputDirectory.
Default is the same name as the source's file.
1.0.0+
Similar to a UNIX permission, sets the file mode of the files included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each component is a sum of Read = 4,
Write = 2, and Execute = 1. For example, the value 0644
translates to User read-write, Group and Other read-only. The default value is 0644
<a href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more on unix-style permissions)</a>
1.0.0+
Sets the line-endings of the files in this file.
Valid values are:
<ul>
<li><b>"keep"</b> - Preserve all line endings</li>
<li><b>"unix"</b> - Use Unix-style line endings (i.e. "\n")</li>
<li><b>"lf"</b> - Use a single line-feed line endings (i.e. "\n")</li>
<li><b>"dos"</b> - Use DOS-/Windows-style line endings (i.e. "\r\n")</li>
<li><b>"windows"</b> - Use DOS-/Windows-style line endings (i.e. "\r\n")</li>
<li><b>"crlf"</b> - Use carriage-return, line-feed line endings (i.e. "\r\n")</li>
</ul>
1.0.0+
Sets whether to determine if the file is filtered.
1.1.0+
Configures a filter for files headed into the assembly archive, to enable
aggregation of various types of descriptor fragments, such as components.xml,
web.xml, etc.
1.1.0+
The handler's plexus role-hint, for lookup from the container.
1.1.1+
Configuration options for the handler.
1.0.0+
A fileSet allows the inclusion of groups of files into the assembly.
1.1.0+
Whether standard exclusion patterns, such as those matching CVS and Subversion
metadata files, should be used when calculating the files affected by this set.
For backward compatibility, the default value is true. (Since 2.2-beta-1)
1.0.0+
Sets the output directory relative to the root
of the root directory of the assembly. For example,
"log" will put the specified files in the log directory.
1.0.0+
When <include> subelements are present, they define a set of
files and directory to include. If none is present, then
<includes> represents all valid values.
1.0.0+
When <exclude> subelements are present, they define a set of
files and directory to exclude. If none is present, then
<excludes> represents no exclusions.
1.0.0+
Similar to a UNIX permission, sets the file mode of the files included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each component is a sum of Read = 4,
Write = 2, and Execute = 1. For example, the value 0644
translates to User read-write, Group and Other read-only. The default value is 0644.
<a href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more on unix-style permissions)</a>
1.0.0+
Similar to a UNIX permission, sets the directory mode of the directories
included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each component is a sum of
Read = 4, Write = 2, and Execute = 1. For example, the value
0755 translates to User read-write, Group and Other read-only. The default value is 0755.
<a href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more on unix-style permissions)</a>
1.0.0+
Sets the absolute or relative location from the module's
directory. For example, "src/main/bin" would select this
subdirectory of the project in which this dependency is defined.
1.0.0+
Sets the line-endings of the files in this fileSet.
Valid values:
<ul>
<li><b>"keep"</b> - Preserve all line endings</li>
<li><b>"unix"</b> - Use Unix-style line endings (i.e. "\n")</li>
<li><b>"lf"</b> - Use a single line-feed line endings (i.e. "\n")</li>
<li><b>"dos"</b> - Use DOS-/Windows-style line endings (i.e. "\r\n")</li>
<li><b>"windows"</b> - Use DOS-/Windows-style line endings (i.e. "\r\n")</li>
<li><b>"crlf"</b> - Use carriage-return, line-feed line endings (i.e. "\r\n")</li>
</ul>
1.1.0+
Whether to filter symbols in the files as they are copied, using
properties from the build configuration. (Since 2.2-beta-1)
1.0.0+
A moduleSet represent one or more project <module> present inside
a project's pom.xml. This allows you to include sources or binaries
belonging to a project's <modules>.
<br/><b>NOTE:</b> When using <moduleSets> from the command-line, it
is required to pass first the package phase by doing: "mvn package
assembly:assembly". This bug/issue is scheduled to be addressed by Maven 2.1.
1.1.2+
If set to true, the plugin will include all projects in the current reactor for processing
in this ModuleSet. These will be subject to include/exclude rules. (Since 2.2)
1.1.0+
If set to false, the plugin will exclude sub-modules from processing in this ModuleSet.
Otherwise, it will process all sub-modules, each subject to include/exclude rules. (Since 2.2-beta-1)
1.0.0+
When <include> subelements are present, they define a set of
project coordinates to include. If none is present, then
<includes> represents all valid values.
Artifact coordinates may be given in simple groupId:artifactId form,
or they may be fully qualified in the form groupId:artifactId:type[:classifier]:version.
Additionally, wildcards can be used, as in *:maven-*
1.0.0+
When <exclude> subelements are present, they define a set of
project artifact coordinates to exclude. If none is present, then
<excludes> represents no exclusions.
Artifact coordinates may be given in simple groupId:artifactId form,
or they may be fully qualified in the form groupId:artifactId:type[:classifier]:version.
Additionally, wildcards can be used, as in *:maven-*
1.0.0+
When this is present, the plugin will include the source files of
the included modules from this set in the resulting assembly.
1.0.0+
When this is present, the plugin will include the binaries of the
included modules from this set in the resulting assembly.
1.0.0+
Contains configuration options for including the source files of a
project module in an assembly.
1.1.0+
Whether standard exclusion patterns, such as those matching CVS and Subversion
metadata files, should be used when calculating the files affected by this set.
For backward compatibility, the default value is true. (Since 2.2-beta-1)
1.0.0+
Sets the output directory relative to the root
of the root directory of the assembly. For example,
"log" will put the specified files in the log directory.
1.0.0+
When <include> subelements are present, they define a set of
files and directory to include. If none is present, then
<includes> represents all valid values.
1.0.0+
When <exclude> subelements are present, they define a set of
files and directory to exclude. If none is present, then
<excludes> represents no exclusions.
1.0.0+
Similar to a UNIX permission, sets the file mode of the files included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each component is a sum of Read = 4,
Write = 2, and Execute = 1. For example, the value 0644
translates to User read-write, Group and Other read-only. The default value is 0644
<a href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more on unix-style permissions)</a>
1.0.0+
Similar to a UNIX permission, sets the directory mode of the directories
included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each component is a sum of
Read = 4, Write = 2, and Execute = 1. For example, the value
0755 translates to User read-write, Group and Other read-only. The default value is 0755.
<a href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more on unix-style permissions)</a>
1.1.0+
Specifies which groups of files from each included module to include in the assembly. A
fileSet is specified by providing one or more of <fileSet> subelements. (Since 2.2-beta-1)
1.1.0+
Specifies whether the module's finalName should be prepended to the outputDirectory
values of any fileSets applied to it. (Since 2.2-beta-1)
1.1.0+
Specifies whether sub-module directories below the current module should be excluded
from fileSets applied to that module. This might be useful if you only mean to copy
the sources for the exact module list matched by this ModuleSet, ignoring (or processing
separately) the modules which exist in directories below the current one. (Since 2.2-beta-1)
1.1.0+
Sets the mapping pattern for all module base-directories included in this assembly.
NOTE: This field is only used if includeModuleDirectory == true.
Default is the module's ${artifactId} in 2.2-beta-1, and ${module.artifactId} in subsequent versions. (Since 2.2-beta-1)
1.0.0+
Contains configuration options for including the binary files of a
project module in an assembly.
1.0.0+
Sets the output directory relative to the root
of the root directory of the assembly. For example,
"log" will put the specified files in the log directory,
directly beneath the root of the archive.
1.0.0+
When <include> subelements are present, they define a set of
artifact coordinates to include. If none is present, then
<includes> represents all valid values.
Artifact coordinates may be given in simple groupId:artifactId form,
or they may be fully qualified in the form groupId:artifactId:type[:classifier]:version.
Additionally, wildcards can be used, as in *:maven-*
1.0.0+
When <exclude> subelements are present, they define a set of
dependency artifact coordinates to exclude. If none is present, then
<excludes> represents no exclusions.
Artifact coordinates may be given in simple groupId:artifactId form,
or they may be fully qualified in the form groupId:artifactId:type[:classifier]:version.
Additionally, wildcards can be used, as in *:maven-*
1.0.0+
Similar to a UNIX permission, sets the file mode of the files included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each component is a sum of Read = 4,
Write = 2, and Execute = 1. For example, the value 0644
translates to User read-write, Group and Other read-only. The default value is 0644
<a href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more on unix-style permissions)</a>
1.0.0+
Similar to a UNIX permission, sets the directory mode of the directories
included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each component is a sum of
Read = 4, Write = 2, and Execute = 1. For example, the value
0755 translates to User read-write, Group and Other read-only. The default value is 0755.
<a href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more on unix-style permissions)</a>
1.1.0+
When specified, the attachmentClassifier will cause the assembler to look at artifacts
attached to the module instead of the main project artifact. If it can find an attached
artifact matching the specified classifier, it will use it; otherwise, it will throw an
exception. (Since 2.2-beta-1)
1.0.0+
If set to true, the plugin will include the direct and transitive dependencies of
of the project modules included here. Otherwise, it will only include the module
packages only.
1.1.0+
Specifies which dependencies of the module to include in the assembly. A
dependencySet is specified by providing one or more of
<dependencySet> subelements. (Since 2.2-beta-1)
1.0.0+
If set to true, this property will unpack all module packages
into the specified output directory. When set to false
module packages will be included as archives (jars).
1.1.0+
Allows the specification of includes and excludes, along with filtering options, for items
unpacked from a module artifact. (Since 2.2-beta-1)
1.0.0+
Sets the mapping pattern for all NON-UNPACKED dependencies included
in this assembly.
(Since 2.2-beta-2; 2.2-beta-1 uses ${artifactId}-${version}${dashClassifier?}.${extension} as default value)
NOTE: If the dependencySet specifies unpack == true, outputFileNameMapping WILL NOT BE USED; in these cases,
use outputDirectory.
See the plugin FAQ for more details about entries usable in the outputFileNameMapping parameter.
1.1.0+
Specifies options for including/excluding/filtering items extracted from an archive. (Since 2.2-beta-1)
1.1.0+
Set of file and/or directory patterns for matching items to be included from an archive as it is unpacked.
Each item is specified as <include>some/path</include> (Since 2.2-beta-1)
1.1.0+
Set of file and/or directory patterns for matching items to be excluded from an archive as it is unpacked.
Each item is specified as <exclude>some/path</exclude> (Since 2.2-beta-1)
1.1.0+
Whether to filter symbols in the files as they are unpacked from the archive, using
properties from the build configuration. (Since 2.2-beta-1)
1.1.2+
Sets the line-endings of the files. (Since 2.2)
Valid values:
<ul>
<li><b>"keep"</b> - Preserve all line endings</li>
<li><b>"unix"</b> - Use Unix-style line endings</li>
<li><b>"lf"</b> - Use a single line-feed line endings</li>
<li><b>"dos"</b> - Use DOS-style line endings</li>
<li><b>"crlf"</b> - Use Carraige-return, line-feed line endings</li>
</ul>
1.1.2+
Whether standard exclusion patterns, such as those matching CVS and Subversion
metadata files, should be used when calculating the files affected by this set.
For backward compatibility, the default value is true. (Since 2.2)
1.1.3+
Allows to specify the encoding to use when unpacking archives, for unarchivers
that support specifying encoding. If unspecified, archiver default will be used.
Archiver defaults generally represent sane (modern) values.
1.0.0+
A dependencySet allows inclusion and exclusion of project dependencies
in the assembly.
1.0.0+
Sets the output directory relative to the root
of the root directory of the assembly. For example,
"log" will put the specified files in the log directory,
directly beneath the root of the archive.
1.0.0+
When <include> subelements are present, they define a set of
artifact coordinates to include. If none is present, then
<includes> represents all valid values.
Artifact coordinates may be given in simple groupId:artifactId form,
or they may be fully qualified in the form groupId:artifactId:type[:classifier]:version.
Additionally, wildcards can be used, as in *:maven-*
1.0.0+
When <exclude> subelements are present, they define a set of
dependency artifact coordinates to exclude. If none is present, then
<excludes> represents no exclusions.
Artifact coordinates may be given in simple groupId:artifactId form,
or they may be fully qualified in the form groupId:artifactId:type[:classifier]:version.
Additionally, wildcards can be used, as in *:maven-*
1.0.0+
Similar to a UNIX permission, sets the file mode of the files included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each component is a sum of Read = 4,
Write = 2, and Execute = 1. For example, the value 0644
translates to User read-write, Group and Other read-only. The default value is 0644
<a href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more on unix-style permissions)</a>
1.0.0+
Similar to a UNIX permission, sets the directory mode of the directories
included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each component is a sum of
Read = 4, Write = 2, and Execute = 1. For example, the value
0755 translates to User read-write, Group and Other read-only. The default value is 0755.
<a href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more on unix-style permissions)</a>
1.1.2+
When specified as true, any include/exclude patterns which aren't used to filter an actual
artifact during assembly creation will cause the build to fail with an error. This is meant
to highlight obsolete inclusions or exclusions, or else signal that the assembly descriptor
is incorrectly configured. (Since 2.2)
1.0.0+
Sets the mapping pattern for all dependencies included in this
assembly. (Since 2.2-beta-2; 2.2-beta-1 uses ${artifactId}-${version}${dashClassifier?}.${extension}
as default value).
See the plugin FAQ for more details about entries usable in the outputFileNameMapping parameter.
1.0.0+
If set to true, this property will unpack all dependencies
into the specified output directory. When set to false
dependencies will be includes as archives (jars). Can only unpack
jar, zip, tar.gz, and tar.bz archives.
1.1.0+
Allows the specification of includes and excludes, along with filtering options, for items
unpacked from a dependency artifact. (Since 2.2-beta-1)
1.0.0+
Sets the dependency scope for this dependencySet.
1.1.0+
Determines whether the artifact produced during the current project's
build should be included in this dependency set. (Since 2.2-beta-1)
1.1.0+
Determines whether the attached artifacts produced during the current project's
build should be included in this dependency set. (Since 2.2-beta-1)
1.1.0+
Determines whether transitive dependencies will be included in the processing of
the current dependency set. If true, includes/excludes/useTransitiveFiltering
will apply to transitive dependency artifacts in addition to the main project
dependency artifacts. If false, useTransitiveFiltering is meaningless, and
includes/excludes only affect the immediate dependencies of the project.
By default, this value is true. (Since 2.2-beta-1)
1.1.0+
Determines whether the include/exclude patterns in this dependency set will be applied to
the transitive path of a given artifact. If true, and the current artifact is a transitive
dependency brought in by another artifact which matches an inclusion or exclusion pattern,
then the current artifact has the same inclusion/exclusion logic applied to it as well. By
default, this value is false, in order to preserve backward compatibility with version 2.1.
This means that includes/excludes only apply directly to the current artifact, and not to
the transitive set of artifacts which brought it in. (Since 2.2-beta-1)
1.0.0+
Defines a Maven repository to be included in the assembly. The artifacts
available to be included in a repository are your project's dependency
artifacts. The repository created contains the needed metadata entries
and also contains both sha1 and md5 checksums. This is useful for creating
archives which will be deployed to internal repositories.
<br/><b>NOTE:</b> Currently, only artifacts from the central repository
are allowed.
1.0.0+
Sets the output directory relative to the root
of the root directory of the assembly. For example,
"log" will put the specified files in the log directory,
directly beneath the root of the archive.
1.0.0+
When <include> subelements are present, they define a set of
artifact coordinates to include. If none is present, then
<includes> represents all valid values.
Artifact coordinates may be given in simple groupId:artifactId form,
or they may be fully qualified in the form groupId:artifactId:type[:classifier]:version.
Additionally, wildcards can be used, as in *:maven-*
1.0.0+
When <exclude> subelements are present, they define a set of
dependency artifact coordinates to exclude. If none is present, then
<excludes> represents no exclusions.
Artifact coordinates may be given in simple groupId:artifactId form,
or they may be fully qualified in the form groupId:artifactId:type[:classifier]:version.
Additionally, wildcards can be used, as in *:maven-*
1.0.0+
Similar to a UNIX permission, sets the file mode of the files included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each component is a sum of Read = 4,
Write = 2, and Execute = 1. For example, the value 0644
translates to User read-write, Group and Other read-only. The default value is 0644
<a href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more on unix-style permissions)</a>
1.0.0+
Similar to a UNIX permission, sets the directory mode of the directories
included.
THIS IS AN OCTAL VALUE.
Format: (User)(Group)(Other) where each component is a sum of
Read = 4, Write = 2, and Execute = 1. For example, the value
0755 translates to User read-write, Group and Other read-only. The default value is 0755.
<a href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more on unix-style permissions)</a>
1.0.0+
If set to true, this property will trigger the creation of repository
metadata which will allow the repository to be used as a functional remote
repository.
1.0.0+
Specifies that you want to align a group of artifacts to a specified
version. A groupVersionAlignment is specified by providing one or
more of <groupVersionAlignment> subelements.
1.1.0+
Specifies the scope for artifacts included in this repository. (Since 2.2-beta-1)
1.0.0+
Allows a group of artifacts to be aligned to a specified version.
1.0.0+
The groupId of the artifacts for which you want to align the
versions.
1.0.0+
The version you want to align this group to.
1.0.0+
When <exclude> subelements are present, they define the
artifactIds of the artifacts to exclude. If none is present, then
<excludes> represents no exclusions. An exclude is specified
by providing one or more of <exclude> subelements.