Apache Maven Shade Plugin – Plugin Documentation

Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal	Description
shade:help	Display help information on maven-shade-plugin. Call `mvn shade:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.
shade:shade	Mojo that performs shading delegating to the Shader component.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven	3.6.3
JDK	1.8

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version	Maven	JDK
from 3.5.2 to 3.6.0	3.6.3	8
from 3.5.0 to 3.5.1	3.2.5	8
from 3.4.0 to 3.4.1	3.1.1	8
3.3.0	3.1.1	7
from 3.2.0 to 3.2.4	3.0	7
from 3.0.0 to 3.1.1	3.0	6
from 2.0 to 2.4.3	3.0	5
from 1.5 to 1.7.1	2.0.6	5
from 1.1 to 1.4	2.0.6	1.4
from 1.0-alpha-13 to 1.0.1	-	-

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-shade-plugin</artifactId>
          <version>3.6.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-shade-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"