This is an automated email from the ASF dual-hosted git repository. kwin pushed a commit to branch bugfix/documentation-improve-mojo-description in repository https://gitbox.apache.org/repos/asf/maven-shade-plugin.git
commit e872553b199242348c0f1229eb82398cb29a2369 Author: Konrad Windszus <[email protected]> AuthorDate: Sun Mar 8 20:40:10 2026 +0100 Improve description of "shade" goal --- src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java b/src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java index 2eb2f64..2a75cc3 100644 --- a/src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java +++ b/src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java @@ -81,7 +81,10 @@ import org.eclipse.aether.resolution.ArtifactResolutionException; import static org.apache.maven.plugins.shade.resource.UseDependencyReducedPom.createPomReplaceTransformers; /** - * Mojo that performs shading delegating to the Shader component. + * Goal that performs shading (i.e. embedding artifacts and optionally relocating them in a new JAR artifact) + * and either makes the shaded JAR the primary artifact or attaches it as secondary artifact. + * The actual shading process is delegated to a {@link Shader} component. + * @see org.apache.maven.plugins.shade.DefaultShader DefaultShader is the default implementation of the Shader component. * * @author Jason van Zyl * @author Mauro Talevi
