Skip to content

Getting Started

plugins {
  java
  id("com.gradleup.shadow") version "<version>"
}

plugins {
  id 'java'
  id 'com.gradleup.shadow' version '<version>'
}

Alternatively, the plugin can be added to the buildscript classpath and applied:

buildscript {
  repositories {
    mavenCentral()
    gradlePluginPortal()
  }
  dependencies {
    classpath("com.gradleup.shadow:shadow-gradle-plugin:<version>")
  }
}
// `apply plugin` stuffs are used with `buildscript`.
apply(plugin = "java")
apply(plugin = "com.gradleup.shadow")

buildscript {
  repositories {
    mavenCentral()
    gradlePluginPortal()
  }
  dependencies {
    classpath 'com.gradleup.shadow:shadow-gradle-plugin:<version>'
  }
}
// `apply plugin` stuffs are used with `buildscript`.
apply plugin: 'java'
apply plugin: 'com.gradleup.shadow'

Snapshots of the development version are available in Sonatype’s snapshots repository. 

buildscript {
  repositories {
    mavenCentral()
    maven("https://oss.sonatype.org/content/repositories/snapshots/")
  }
  dependencies {
    classpath("com.gradleup.shadow:shadow-gradle-plugin:<version>")
  }
}
// `apply plugin` stuffs are used with `buildscript`.
apply(plugin = "java")
apply(plugin = "com.gradleup.shadow")

Snapshots of the development version are available in Sonatype’s snapshots repository. 

buildscript {
  repositories {
    mavenCentral()
    maven { url = 'https://oss.sonatype.org/content/repositories/snapshots/' }
  }
  dependencies {
    classpath 'com.gradleup.shadow:shadow-gradle-plugin:<version>'
  }
}
// `apply plugin` stuffs are used with `buildscript`.
apply plugin: 'java'
apply plugin: 'com.gradleup.shadow'

NOTE: The correct maven coordinates for each version of Shadow can be found by referencing the Gradle Plugin documentation here.

Shadow is a reactive plugin. This means that applying Shadow by itself will perform no configuration on your project. Instead, Shadow reacts This means, that for most users, the java or groovy plugins must be explicitly applied to have the desired effect.

Default Java/Kotlin/Groovy Tasks

In the presence of the java, org.jetbrains.kotlin.jvm or groovy plugins (that apply JavaPlugin in their build logic), Shadow will automatically configure the following behavior:

  • Adds a shadowJar task to the project.
  • Adds a shadow configuration to the project.
  • Adds a shadow variant to the project.
  • Adds a shadow component to the project.
  • Configures the shadowJar task to include all sources from the project’s main sourceSet.
  • Configures the shadowJar task to bundle all dependencies from the runtimeClasspath configuration.
  • Configures the classifier attribute of the shadowJar task to be 'all' .
  • Configures the shadowJar task to generate a Manifest with:
    • Inheriting all configuration from the standard jar task.
    • Adds a Class-Path attribute to the Manifest that appends all dependencies from the shadow configuration
  • Configures the shadowJar task to exclude any JAR index or cryptographic signature files matching the following patterns:
    • META-INF/INDEX.LIST
    • META-INF/*.SF
    • META-INF/*.DSA
    • META-INF/*.RSA
    • META-INF/versions/**/module-info.class
    • module-info.class
  • Creates and registers the shadow component in the project (used for integrating with maven-publish).