This is an automated email from the ASF dual-hosted git repository.
kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-shade-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 014eabc Improve description of "shade" goal
014eabc is described below
commit 014eabcc47a26c8a781a01d085a3e245577dca81
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 | 7 ++++++-
1 file changed, 6 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..c87b31c 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,12 @@ 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.
+ * Creates a shaded JAR artifact (i.e. embeds additional artifacts and
optionally relocates their packages).
+ * The generated shaded JAR becomes either the primary artifact or a secondary
artifact of the current project.
+ * The actual shading process is delegated to a {@link Shader} component.
+ * It supports relocating references in binary classes and optionally also in
Java source files, as well as resource transformations.
+ * @see org.apache.maven.plugins.shade.DefaultShader DefaultShader (the
default implementation of the Shader component).
+ * @see <a
href="https://maven.apache.org/plugins/maven-shade-plugin/examples/resource-transformers.html";>Resource
Transformers</a>
*
* @author Jason van Zyl
* @author Mauro Talevi
