You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Apache Wiki <wi...@apache.org> on 2005/11/14 14:39:30 UTC

[Maven Wiki] Update of "AssemblyPlugin" by AlexanderHars

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Maven Wiki" for change notification.

The following page has been changed by AlexanderHars:
http://wiki.apache.org/maven/AssemblyPlugin

New page:
= AssemblyPlugin =

[http://maven.apache.org/guides/mini/guide-assemblies.html Guide to creating assemblies] 

[http://maven.apache.org/plugins/maven-assembly-plugin/howto.html How to use assembly plugin] - good

[http://maven.apache.org/plugins/maven-assembly-plugin/descriptor.html Predefined Descriptors] - very useful

[http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html Descriptor format] - most descriptors have no description


== Goals ==

 * assembly:assembly (default goal) Creates a distribution artifact
 * assembly:directory copies files into a directory structure without packing those file
 * assembly:unpack  unpacks packed files

== Descriptors ==

An assembly file consists of three sections


=== General assembly properties ===

|| <id>      || the id.  ||
|| <formats> || list of package formats that should be generated, each in <format> descriptor ||
|| <format>  || jar, tar.gz, tar.bz2, zip ''if you know of others, please add them here'' ||
|| <includeBaseDirectory>  || defaults to false. Determines if the base directory should be included in the package. ||


=== <filesets> ===

|| <outputDirectory> || Directory in the target tree where the files should be copied to. ||
|| <directory> || copies the contents of this directory to the specified target directory. Copies files by name, does not copy path. ''if anyone could clarify what other types of patterns can be specified that would be great!''||
|| <includes>   || copies the specified files that match the pattern (e.g. *.txt) to the target directory. Includes the directory path when copying. ||
|| <excludes>   || Excludes the specified files that match the pattern (e.g. *.txt) from being copied to the target directory. ||
|| <lineEnding>  ||  ||
|| <directoryMode>  ||  ||
|| <fileMode>  ||  ||

=== <dependencySets> ===

|| <outputDirectory> || Directory in the target tree where the dependencies should be copied to. ||
|| <includes>   || Includes the specified dependency ||
|| <excludes>   || Excludes the specified dependency ||
|| <unpack>  || Unpacks the contents of the dependencies ||
|| <scope>  ||  ||
|| <outputFileNameMapping>  ||  ||
|| <directoryMode>  ||  ||
|| <fileMode>  ||  ||


== How To ==

  * How to copy files into some target directory structure without packaging. 

  This can be accomplished with the assembly:directory goal. There is only a small downside: The directory  
  goal always creates a folder below the target directory that is version-specific. This version-specific directory
  is even created when <includeBaseDirectory> is set to false (that may be a bug). 

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org