assembly Assembly A definition of an assembly. This descriptor specifies the type of assembly archive to create, the contents of the assembly, and the ways in which dependencies are bundled with an assembly.

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.

]]> package org.apache.maven.plugins.assembly.model Assembly Describes the assembly layout and packaging. 1.0.0 id 1.0.0 true String The id of this assembly. This is a symbolic name for a particular assembly of files from this project. formats 1.0.0 true String *
  • "zip" - Creates a ZIP file format
  • "gz" - Creates a GZIP format
  • "tar" - Creates a TAR format
  • "tar.gz" - Creates a gzip'd TAR format
  • "tar.bz2 - Creates a bzip'd TAR format
    • ]]>     includeBaseDirectory boolean true 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. includeSiteDirectory boolean false moduleSets 1.0.0 ModuleSet * Specify which modules source files to include in the assembly fileSets 1.0.0 FileSet * Specify assembly parameters for groups of files. files 1.0.0 FileItem * Specify assembly parameters for single files. dependencySets 1.0.0 DependencySet * Specify assembly behavior for sets of dependencies. repositories 1.0.0 Repository * Specify assembly behavior for sets of repositories. componentDescriptors 1.0.0 String * File relative to basedir containing Component.     SetBase 1.0.0 outputDirectory 1.0.0 String Specifies 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. includes 1.0.0 String * excludes 1.0.0 String * fileMode 1.0.0 String 0644 (more on unix-style permissions) ]]> directoryMode 1.0.0 String 0755 (more on unix-style permissions) ]]> FileSet 1.0.0 SetBase directory 1.0.0 String Absolute or relative from the module's directory. For example, "src/main/bin" would select this subdirectory of the project in which this dependency is defined. true lineEnding 1.0.0 String
  • "keep" - Preserve all line endings
  • "unix" - Use Unix-style line endings
  • "lf" - Use a single line-feed line endings
  • "dos" - Use DOS-style line endings
  • "crlf" - Use Carraige-return, line-feed line endings
    • ]]>     FileItem 1.0.0 Allows individual file copy with option to change destination file name not supported by fileSet source 1.0.0 String true Absolute or relative from the module's directory. outputDirectory 1.0.0 String false Specifies 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. destName 1.0.0 String Destination file name in outputDirectory. Default is the same name as the source's file. fileMode 1.0.0 String 0644 (more on unix-style permissions) ]]> lineEnding 1.0.0 String
  • "keep" - Preserve all line endings
  • "unix" - Use Unix-style line endings
  • "lf" - Use a single line-feed line endings
  • "dos" - Use DOS-style line endings
  • "crlf" - Use Carraige-return, line-feed line endings
    • ]]>     filtered 1.0.0 boolean Flag used to determine if the file is filtered.     DependencySet 1.0.0 SetBase Defines a dependency set outputFileNameMapping 1.0.0 String ${artifactId}-${version}.${extension} Specify the mapping pattern for all dependencies included in this assembly. Default is ${artifactId}-${version}.${extension}. unpack boolean false 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). Default value is false. scope 1.0.0 String runtime true Specifies the dependency scope for this dependencySet. Default scope value is "runtime". ModuleSet 1.0.0 includes 1.0.0 String * excludes 1.0.0 String * sources 1.0.0 When this is configured, the plugin will include the source files of the included modules from this set in the resulting assembly, according to the configuration. ModuleSources binaries 1.0.0 When this is configured, the plugin will include the binaries of the included modules from this set in the resulting assembly, according to the configuration. ModuleBinaries ModuleSources 1.0.0 SetBase Configuration for including the source files for a Module in an assembly. ModuleBinaries 1.0.0 SetBase Configuration for including the binary files for a Module in an assembly. includeDependencies 1.0.0 boolean false 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. Default value is false. unpack boolean true 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). Default value is true. outputFileNameMapping 1.0.0 String ${artifactId}-${version}.${extension} Specify the mapping pattern for all dependencies included in this assembly. Default is ${artifactId}-${version}.${extension}. Repository 1.0.0 SetBase Defines a Maven repository to be included in the assembly. includeMetadata 1.0.0 boolean false 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. groupVersionAlignments 1.0.0 Align a group to a version or an individual artifact. GroupVersionAlignment * GroupVersionAlignment 1.0.0 Defines a Maven repository to be included in the assembly. id 1.0.0 String The groupId for which you want to align the versions. version 1.0.0 String The version you want to align this group to. excludes 1.0.0 Artifact Ids of the artifacts you want excluded from version alignment. String *