Full name:
org.apache.maven.plugins:maven-shade-plugin:1.5:shade
Description:
Attributes:
| Name | Type | Since | Description |
|---|---|---|---|
| artifactSet | ArtifactSet | - | Artifacts to include/exclude from the final artifact. Artifacts are
denoted by composite identifiers of the general form
groupId:artifactId:type:classifier. Since version 1.3,
the wildcard characters '*' and '?' can be used within the sub
parts of those composite identifiers to do pattern matching. For
convenience, the syntax groupId is equivalent to
groupId:*:*:*, groupId:artifactId is
equivalent to groupId:artifactId:*:* and
groupId:artifactId:classifier is equivalent to
groupId:artifactId:*:classifier. For example:
<artifactSet>
<includes>
<include>org.apache.maven:*</include>
</includes>
<excludes>
<exclude>*:maven-core</exclude>
</excludes>
</artifactSet>
|
| createDependencyReducedPom | boolean | - | Flag whether to generate a simplified POM for the shaded artifact.
If set to true, dependencies that have been included
into the uber JAR will be removed from the
<dependencies> section of the generated POM. The
reduced POM will be named dependency-reduced-pom.xml
and is stored into the same directory as the shaded artifact. Default value is: true. |
| createSourcesJar | boolean | - | When true, it will attempt to create a sources jar as well Default value is: false. |
| filters | ArchiveFilter[] | - | Archive Filters to be used. Allows you to specify an artifact in
the form of a composite identifier as used by
artifactSet and a set of include/exclude file patterns
for filtering which contents of the archive are added to the shaded
jar. From a logical perspective, includes are processed before
excludes, thus it's possible to use an include to collect a set of
files from the archive then use excludes to further reduce the set.
By default, all files are included and no files are excluded. If
multiple filters apply to an artifact, the intersection of the
matched files will be included in the final JAR. For example:
<filters>
<filter>
<artifact>junit:junit</artifact>
<includes>
<include>org/junit/**</include>
</includes>
<excludes>
<exclude>org/junit/experimental/**</exclude>
</excludes>
</filter>
</filters>
|
| finalName | String | - | The name of the shaded artifactId. If you like to change the name
of the native artifact, you may use the
<build><finalName> setting. If this is set to something
different than <build><finalName>, no file replacement
will be performed, even if shadedArtifactAttached is being used. |
| keepDependenciesWithProvidedScope | boolean | - | When true, dependencies are kept in the pom but with scope
'provided'; when false, the dependency is removed. Default value is: false. |
| minimizeJar | boolean | 1.4 | When true, dependencies will be stripped down on the class level to
only the transitive hull required for the artifact. Note:
Usage of this feature requires Java 1.5 or higher. Default value is: false. |
| outputDirectory | File | - | The destination directory for the shaded artifact. Default value is: ${project.build.directory}. |
| outputFile | File | 1.3 | The path to the output file for the shaded artifact. When this
parameter is set, the created archive will neither replace the
project's main artifact nor will it be attached. Hence, this
parameter causes the parameters finalName,
shadedArtifactAttached,
shadedClassifierName and
createDependencyReducedPom to be ignored when used. |
| promoteTransitiveDependencies | boolean | - | When true, transitive deps of removed dependencies are promoted to
direct dependencies. This should allow the drop in replacement of
the removed deps with the new shaded jar and everything should
still work. Default value is: false. |
| relocations | PackageRelocation[] | - | Packages to be relocated. For example:
<relocations>
<relocation>
<pattern>org.apache</pattern>
<shadedPattern>hidden.org.apache</shadedPattern>
<includes>
<include>org.apache.maven.*</include>
</includes>
<excludes>
<exclude>org.apache.maven.Public*</exclude>
</excludes>
</relocation>
</relocations>
|
| shadedArtifactAttached | boolean | - | Defines whether the shaded artifact should be attached as
classifier to the original artifact. If false, the shaded jar will
be the main artifact of the project Default value is: false. |
| shadedArtifactId | String | - | The name of the shaded artifactId. So you may want to use a
different artifactId and keep the standard version. If the original
artifactId was "foo" then the final artifact would be something
like foo-1.0.jar. So if you change the artifactId you might have
something like foo-special-1.0.jar. Default value is: ${project.artifactId}. |
| shadedClassifierName | String | - | The name of the classifier used in case the shaded artifact is
attached. Default value is: shaded. |
| shadedGroupFilter | String | - | If specified, this will include only artifacts which have groupIds
which start with this. |
| transformers | ResourceTransformer[] | - | Resource transformers to be used. Please see the "Examples" section
for more information on available transformers and their
configuration. |
<artifactSet>
<includes>
<include>org.apache.maven:*</include>
</includes>
<excludes>
<exclude>*:maven-core</exclude>
</excludes>
</artifactSet>
<filters>
<filter>
<artifact>junit:junit</artifact>
<includes>
<include>org/junit/**</include>
</includes>
<excludes>
<exclude>org/junit/experimental/**</exclude>
</excludes>
</filter>
</filters>
keepDependenciesWithProvidedScope:
promoteTransitiveDependencies:
<relocations>
<relocation>
<pattern>org.apache</pattern>
<shadedPattern>hidden.org.apache</shadedPattern>
<includes>
<include>org.apache.maven.*</include>
</includes>
<excludes>
<exclude>org.apache.maven.Public*</exclude>
</excludes>
</relocation>
</relocations>