Assembly Plugin Example - Including Module Artifacts


It is common practice to create an assembly using the parent POM of a multimodule build. At times, you may want to ensure that this assembly also includes one or more of the module artifacts.

This example demonstrates how to include the artifact and dependencies of a module, under the directory modules/<module-name>.

The Assembly Descriptor

First, let's write an assembly descriptor to create this assembly. For the sake of clarity, this descriptor will be as simple as possible, only demonstrating the features described by this example.


This descriptor states that the assembly id should be bin, that the output format is a directory, and that the contents of the assembly should not be contained within a directory named after the finalName of the top-level project.

Furthermore, it states that we wish to include the artifact files for the module with a groupId of org.test and an artifactId of child1, along with its dependency artifacts. These artifacts should be contained within the directory structure modules/child1 for this module, since the outputDirectory expression will be interpolated on a module-by-module basis.


Now, let's review the POM configuration necessary to enable the building of this assembly via the assembly:directory mojo:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns=""



This POM simply directs the assembly plugin to use the bin.xml assembly descriptor when executing.


To build the assembly, we issue the following command:

mvn clean package assembly:directory

This will ensure that the output directory (normally, target), is removed before building the assembly directory.

NOTE: Because of a quirk in Maven 2.0's execution model relating to aggregator mojos and the inheritance hierarchy, we need to explicitly execute the package phase ahead of the assembly invocation, to ensure all modules have been built.

Examining the Output

When the Maven execution completes, the following directory structure should be left:

`-- modules
    `-- child1
        |-- child1-1.0.jar
        `-- junit-3.8.1.jar