imperceptiblethoughts.com Open in urlscan Pro
185.199.111.153  Public Scan

Form analysis
0 forms found in the DOM

Text Content

User Guide
GitHub (opens new window)

User Guide
GitHub (opens new window)
 * Home
 * Introduction
 * Getting Started
 * Configuring Shadow
   * Configuring Output Name
   * Configuring the Runtime Classpath
   * Configuring the JAR Manifest
 * Filtering Shadow Jar Contents
 * Configuring Shadowed Dependencies
 * Controlling JAR Content Merging
 * Relocating Packages
 * Minimizing
 * Reproducible Builds
 * Creating a Custom ShadowJar Task
 * Integrating with Application Plugin
 * Publishing Shadow JARs
 * Using Shadow in Multi-Project Builds
 * Using Shadow to Package Gradle Plugins
 * Change Log
 * About This Project


# CONFIGURING SHADOW

The ShadowJar(opens new window) task type extends from Gradle's Jar(opens new
window) type. This means that all attributes and methods available on Jar are
also available on ShadowJar(opens new window) . Refer the Gradle User Guide for
Jar(opens new window) for details.


# CONFIGURING OUTPUT NAME

Shadow configures the default shadowJar task to set the output JAR's
destinationDir, archiveBaseName, appendix, archiveVersion, and extension to the
same default values as Gradle does for all Jar tasks. Additionally, it
configures the archiveClassifier to be all.

If working with a Gradle project with the name myApp and archiveVersion 1.0, the
default shadowJar task will output a file at: build/libs/myApp-1.0-all.jar

As with all Jar tasks in Gradle, these values can be overridden:

// Output to build/libs/shadow.jar
shadowJar {
   archiveBaseName.set('shadow')
   archiveClassifier.set('')
   archiveVersion.set('')
}



# CONFIGURING THE RUNTIME CLASSPATH

Each Java JAR file contains a manifest file that provides meta data about the
contents of the JAR file itself. When using a shadowed JAR file as an executable
JAR, it is assumed that all necessary runtime classes are contained within the
JAR itself. There may be situations where the desire is to not bundle select
dependencies into the shadowed JAR file but they are still required for runtime
execution.

In these scenarios, Shadow creates a shadow configuration to declare these
dependencies. Dependencies added to the shadow configuration are not bundled
into the output JAR. Think of configurations.shadow as unmerged, runtime
dependencies. The integration with the maven-publish plugin will automatically
configure dependencies added to configurations.shadow as RUNTIME scope
dependencies in the resulting POM file.

Additionally, Shadow automatically configures the manifest of the shadowJar task
to contain a Class-Path entry in the JAR manifest. The value of the Class-Path
entry is the name of all dependencies resolved in the shadow configuration for
the project.

dependencies {
  shadow 'junit:junit:3.8.2'
}


Inspecting the META-INF/MANIFEST.MF entry in the JAR file will reveal the
following attribute:

Class-Path: junit-3.8.2.jar


When deploying a shadowed JAR as an execution JAR, it is important to note that
any non-bundled runtime dependencies must be deployed in the location specified
in the Class-Path entry in the manifest.


# CONFIGURING THE JAR MANIFEST

Beyond the automatic configuration of the Class-Path entry, the shadowJar
manifest is configured in a number of ways. First, the manifest for the
shadowJar task is configured to inherit from the manifest of the standard jar
task. This means that any configuration performed on the jar task will propagate
to the shadowJar tasks.

jar {
   manifest {
       attributes 'Class-Path': '/libs/a.jar'
   }
}


Inspecting the META-INF/MANIFEST.MF entry in the JAR file will reveal the
following attribute:

Class-Path: /libs/a.jar


If it is desired to inherit a manifest from a JAR task other than the standard
jar task, the inheritFrom methods on the shadowJar.manifest object can be used
to configure the upstream.

task testJar(type: Jar) {
  manifest {
    attributes 'Description': 'This is an application JAR'
  }
}

shadowJar {
  manifest {
    inheritFrom project.tasks.testJar.manifest
  }
}


Help improve these docs! (opens new window)

← Getting Started Filtering Shadow Jar Contents →