Fixed

• Fix the regression of registeringShadowJar tasks withoutShadowPlugin applied. (#1787)

Added

• Support relocating Groovy extensions in Module descriptors. (#1705)
• Add extensions forIterable<Relocator>. (#1710)
• Support relocating list of types inRelocatorRemapper. (#1714)
• AddmainClass property intoShadowJar. (#1722)

  tasks.shadowJar {// This property will be used as a fallback if there is no explicit `Main-Class` attribute set.  mainClass="my.Main"}

• HonorexecutableDir andapplicationName inapplication extension. (#1740)
  This is useful when you want to customize the output directory of the start scripts and the application distribution.
• Provide more task accessors inShadowApplicationPlugin.Companion. (#1771)
• Support relocating Kotlin module files. (#1539)
  The current implementation relocates all properties inKotlinModuleMetadata butKmModule.optionalAnnotationClasses due to very limited usage of it. See more discussionhere.
• Allow overridingBUNDLING_ATTRIBUTE in GMM. (#1773)
  Theorg.gradle.dependency.bundling in shadowed JAR's Gradle Module Metadata is set toshadowed by default. You can override it for now by:

  shadow {  bundlingAttribute=Bundling.EMBEDDED}

Changed

• Merge Gradle Module descriptors into the modernMETA-INF path. (#1706)
  The Gradle Module descriptors (org.codehaus.groovy.runtime.ExtensionModule files) defined underMETA-INF/services/
  andMETA-INF/groovy will be merged intoMETA-INF/groovy/org.codehaus.groovy.runtime.ExtensionModule.
• Move injectingClass-Path manifest attr logic fromdoFirst intocopy. (#1720)
• Move injectingMain-Class manifest attr logic fromdoFirst intocopy. (#1724)
• DeprecateInheritManifest andinheritFrom. (#1722)

  tasks.shadowJar {// Before (deprecated):  manifest.inheritFrom(tasks.jar.get().manifest)// After (recommended):  manifest.from(tasks.jar.get().manifest)// Note: You don't need to inherit the manifest from `jar` task as it's done by default for the `shadowJar` task.// But if you want to inherit the manifest for your custom `ShadowJar` task, you still need to do it explicitly.}

• Use defaultJavaExec error message when main class is not set. (#1725)
• UpdateRelocatorRemapper class pattern to cover more Java method descriptors. (#1731)
• Stop using start script templates bundled in Shadow. (#1738)
• Bump min Java requirement to 17. (#1744)
• Require most optional properties non-null. (#1745)
• Make assemble depend on shadowJar even if it is added later. (#1766)

Fixed

• Fix excluding dependencies whose versions contain+. (#1597)

Added

• Allow opting out ofshadowRuntimeElements variant. (#1662)

  shadow {// Disable publishing `shadowRuntimeElements` as an optional variant of the `java` component.  addShadowVariantIntoJavaComponent=false}// configuration must be done in the `afterEvaluate` phase, you cannot access `shadowRuntimeElements` before that.val javaComponent= components["java"]asAdhocComponentWithVariantsjavaComponent.withVariantsFromConfiguration(configurations["shadowRuntimeElements"]) {// See more details in https://github.com/GradleUp/shadow/pull/1662.  skip()}

• Allow opting out ofTARGET_JVM_VERSION_ATTRIBUTE. (#1674)

  shadow {// Disable adding `TargetJvmVersion` attribute into the Gradle Module Metadata of the shadowed jar.  addTargetJvmVersionAttribute=false}

• Allow opting out ofMulti-Release attribute. (#1675)

  tasks.shadowJar {// Disable adding `Multi-Release` attribute into the manifest of the shadowed jar.  addMultiReleaseAttribute=false}

Changed

• Don't injectTargetJvmVersion attribute when automatic JVM targeting is disabled. (#1666)
• Do not write modified class files for no-op relocations. (#1694)
• BREAKING CHANGE: The introduction of someafterEvaluate usages may cause configuration issues in rare cases.

Fixed

• Fix missing space inApacheNoticeResourceTransformer preamble causing malformed NOTICE header. (#1623)
• Fix usingApacheNoticeResourceTransformer withoutprojectName. (#1627)
• Fix extra indents ofApacheNoticeResourceTransformer output. (#1628)
• Fix resolving BOM dependencies whenminimize is enabled. (#1637)

Changed

• Improve the error message for emptymainClassName. (#1601)
• DefaultduplicatesStrategy back toEXCLUDE. (#1617)
  • This strategy is consistent with 8.x series behavior, which is more compatible for most users upgrading.
  • For mostResourceTransformer users, you need to override the strategy toINCLUDE to make them work.
  • Strongly suggest declaring theduplicatesStrategy explicitly in yourShadowJar configuration to avoid confusion.
  • See more details about the strategies atHandling Duplicates Strategy.

Fixed

• Fix the regression of can't shadow directory inputs. (#1606)
• Fix the regression ofMinimizeDependencyFilter. (#1611)

Added

• Add .md support to the Apache License and Notice transformers. (#1041)
• SyncSimpleRelocator changes from maven-shade-plugin. (#1076)
• Support configuringseparator inAppendingTransformer. (#1169)
  This is useful for handling files likeresources/application.yml.
• Excludemodule-info.class in Multi-Release folders by default. (#1177)
• InjectTargetJvmVersion attribute for Gradle Module Metadata. (#1199)
• SyncShadowApplicationPlugin withApplicationPlugin. (#1224)
• InjectMulti-Release manifest attribute if any dependency contains it. (#1239)
• MarkTransformer as throwingIOException. (#1248)
• Reduce duplicateSimpleRelocator to improve performance. (#1271)
• Compat Kotlin Multiplatform plugin. (#1280)
• Add Kotlin DSL examples in docs. (#1306)
• Support using type-safe dependency accessors inShadowJar.dependencies. (#1322)
• Support command line options forShadowJar. (#1365)

  --enable-auto-relocation          Enables auto relocation of packages in the dependencies.--no-enable-auto-relocation       Disables option --enable-auto-relocation.--fail-on-duplicate-entries       Fails build if the ZIP entries in the shadowed JAR are duplicate.--no-fail-on-duplicate-entries    Disables option --fail-on-duplicate-entries.--minimize-jar                    Minimizes the jar by removing unused classes.--no-minimize-jar                 Disables option --minimize-jar.--relocation-prefix               Prefix used for auto relocation of packages in the dependencies.--rerun                           Causes the task to be re-run even if up-to-date.

• Support skipping string constant remapping. (#1401)
• Letassemble depend onshadowJar. (#1524)
• Fail build when inputting AAR files or using Shadow with AGP. (#1530)
• AddPreserveFirstFoundResourceTransformer. (#1548)
  This is useful when you setshadowJar.duplicatesStrategy = DuplicatesStrategy.INCLUDE and
  want to ensure that only the first found resource is included in the final JAR.
• Fail build if the ZIP entries in the shadowed JAR are duplicate. (#1552)
  This feature is controlled by theshadowJar.failOnDuplicateEntries property, which isfalse by default.
  Related to settingduplicatesStrategy = DuplicatesStrategy.FAIL but there are some differences:
  • It only checks the entries in the shadowed jar, not the input files.
  • It works with settingduplicatesStrategy to any value.
  • It provides a stricter fallback check before the JAR is created.

Changed

• BREAKING CHANGE: Rewrite this plugin in Kotlin. (#1012)
• BREAKING CHANGE: MigrateTransformers to using lazy properties. (#1036)
• BREAKING CHANGE: MigrateShadowJar to using lazy properties. (#1044)
• BREAKING CHANGE: ResolveConfiguration directly inDependencyFilter. (#1045)
• BREAKING CHANGE: MigrateSimpleRelocator to using lazy properties. (#1047)
• BREAKING CHANGE: Some public getters have been updated inSimpleRelocator. (#1079)
• BREAKING CHANGE: Migrate allListProperty usages toSetProperty. (#1103)
  Some publicList parameters are also changed toSet.
• BREAKING CHANGE: MarkRelocatorRemapper asinternal. (#1227)
• BREAKING CHANGE: Bump min Java requirement to 11. (#1242)
• BREAKING CHANGE: Move tracking unused classes logic out ofShadowCopyAction. (#1257)
• BREAKING CHANGE: MoveDependencyFilter intotasks package. (#1272)
• BREAKING CHANGE: Change the defaultduplicatesStrategy fromEXCLUDE toINCLUDE. (#1233)
  • ShadowJar recognizedEXCLUDE as the default, but the other strategies didn't work properly.
  • NowShadowJar honorsINCLUDE as the default, and aligns all the strategy behaviors with the Gradle side.
  • SomeResourceTransformers (e.g.ServiceFileTransformer) do not work withEXCLUDE, as it will exclude duplicate resources to be merged.
  • Duplicate entries might be bundled due to this change, but you can reduce them by using the newly addedPreserveFirstFoundResourceTransformer.
  • UsefilesMatching to override the default strategy for specific files.
  • SetfailOnDuplicateEntries = true to fail the build to check for duplicate entries.
  • See more details atHandling Duplicates Strategy.
  • Note: The defaultduplicatesStrategy is changed back toEXCLUDE in 9.0.1 release.
• BREAKING CHANGE: Align the behavior ofShadowTask.from with Gradle'sAbstractCopyTask.from. (#1233)
  In the previous versions,ShadowTask.from would always unzip the files before processing them, which caused serial
  issues that are hard to fix. Now it behaves like Gradle'sAbstractCopyTask.from, which means it will not unzip
  the files, only copy the files as-is. If you still want to shadow the unzipped files, try out something like:

    tasks.shadowJar {// Unzip the files before pass them to `from` by using `zipTree`.    from(zipTree(files('path/to/your/file.zip')))  }

  or

    dependencies {// Add the files to `implementation` configuration, Shadow will unzip them automatically.    implementation(files('path/to/your/file.zip'))  }

• BREAKING CHANGE: RenameTransformer toResourceTransformer. (#1288)
  Aims to better align with the nameorg.apache.maven.plugins.shade.resource.ResourceTransformer.java
  and to distinguish itself fromorg.gradle.api.Transformer.java.
• BREAKING CHANGE: MarkDefaultInheritManifest asinternal. (#1303)
• BREAKING CHANGE: PolishShadowSpec. (#1307)
  • Return values ofShadowSpec functions are changed toUnit to avoid confusion.
  • ShadowSpec no longer extendsCopySpec.
  • Overloadrelocate,transform and things for better usability in Kotlin.
• BREAKING CHANGE: Remove redundant types from function returning. (#1308)
• BREAKING CHANGE: RenameShadowJar'sisEnableRelocation toenableAutoRelocation. (#1541)
• BREAKING CHANGE: Some const values inShadowBasePlugin andShadowJavaPlugin are moved. (#1589)
  You can find them inShadowJar,ShadowApplicationPlugin, andShadowJavaPlugin.
• Replace deprecatedSelfResolvingDependency withFileCollectionDependency. (#1114)
• Update start script templates. (#1183)
• Mark moreTransformers cacheable. (#1210)
• MarkShadowJar.dependencyFilter as@Input. (#1206)
• PolishstartShadowScripts task registering. (#1216)
• Refactor file visiting logic inStreamAction, handle file unzipping viaProject.zipTree. (#1233)
• Migrate doc sites to MkDocs. (#1302)
• runShadow no longer depends oninstallShadowDist. (#1353)
• Move the group ofShadowJar fromshadow tobuild. ([#1355](https...

Contributors

Changed

• UseBufferedOutputStream when writing the Zip file to improve performance. (#1579)

Added

• AddPreserveFirstFoundResourceTransformer. (#1548)
  This is useful when you setshadowJar.duplicatesStrategy = DuplicatesStrategy.INCLUDE (the default behavior) and want to ensure that only the first found resource is included in the final JAR.
• Fail build if the ZIP entries in the shadowed JAR are duplicate. (#1552)
  This feature is controlled by theshadowJar.failOnDuplicateEntries property, which isfalse by default.
  Related to settingduplicatesStrategy = DuplicatesStrategy.FAIL but there are some differences:
  • It only checks the entries in the shadowed jar, not the input files.
  • It works with settingduplicatesStrategy to any value.
  • It provides a more strict check before the JAR is created.

Changed

• BREAKING CHANGE: RenameShadowJar'senableRelocation toenableAutoRelocation. (#1541)
  The Command Line options are also updated:

  --enable-auto-relocation          Enables auto relocation of packages in the dependencies.--no-enable-auto-relocation       Disables option --enable-auto-relocation.--fail-on-duplicate-entries       Fails build if the ZIP entries in the shadowed JAR are duplicate.--no-fail-on-duplicate-entries    Disables option --fail-on-duplicate-entries.--minimize-jar                    Minimizes the jar by removing unused classes.--no-minimize-jar                 Disables option --minimize-jar.--relocation-prefix               Prefix used for auto relocation of packages in the dependencies.--rerun                           Causes the task to be re-run even if up-to-date.

• MarkAction parameters as non-null. (#1555)

Removed

• Remove JVM default compat stuff. (#1556)

Added

• Support skipping string constant remapping. (#1401)
• Letassemble depend onshadowJar. (#1524)
• Fail build when inputting AAR files or using Shadow with AGP. (#1530)

Changed

• Restore Develocity Build Scan integration. (#1505)
  It is still disabled by default, you can enable it by settingcom.gradleup.shadow.enableDevelocityIntegration = true.
• ExposeAbstractDependencyFilter frominternal topublic. (#1538)
  You can access it viacom.github.jengelman.gradle.plugins.shadow.tasks.DependencyFilter.AbstractDependencyFilter.

Fixed

• Honoroptions.release for target JVM attribute. (#1502)

Added

• Add .md support to the Apache License and Notice transformers. (#1041)
• SyncSimpleRelocator changes from maven-shade-plugin. (#1076)
• Support configuringseparator inAppendingTransformer. (#1169)
  This is useful for handling files likeresources/application.yml.
• Excludemodule-info.class in Multi-Release folders by default. (#1177)
• InjectTargetJvmVersion attribute for Gradle Module Metadata. (#1199)
• SyncShadowApplicationPlugin withApplicationPlugin. (#1224)
• InjectMulti-Release manifest attribute if any dependency contains it. (#1239)
• MarkTransformer as throwingIOException. (#1248)
• Compat Kotlin Multiplatform plugin. (#1280)
• Add Kotlin DSL examples in docs. (#1306)
• Support using type-safe dependency accessors inShadowJar.dependencies. (#1322)
• Support command line options forShadowJar. (#1365)

  --enable-relocation       Enable relocation of packages in the jar--no-enable-relocation    Disables option --enable-relocation--minimize-jar            Minimize the jar by removing unused classes--no-minimize-jar         Disables option --minimize-jar--relocation-prefix       Prefix to use for relocated packages--rerun                   Causes the task to be re-run even if up-to-date

Changed

• BREAKING CHANGE: Rewrite this plugin in Kotlin. (#1012)
• BREAKING CHANGE: MigrateTransformers to using lazy properties. (#1036)
• BREAKING CHANGE: MigrateShadowJar to using lazy properties. (#1044)
• BREAKING CHANGE:ShadowJar'sisEnableRelocation has been renamed toenableRelocation. (#1044)
• BREAKING CHANGE: ResolveConfiguration directly inDependencyFilter. (#1045)
• BREAKING CHANGE: MigrateSimpleRelocator to using lazy properties. (#1047)
• BREAKING CHANGE: Some public getters have been updated inSimpleRelocator. (#1079)
• BREAKING CHANGE: Migrate allListProperty usages toSetProperty. (#1103)
  Some publicList parameters are also changed toSet.
• BREAKING CHANGE: MarkRelocatorRemapper asinternal. (#1227)
• BREAKING CHANGE: Bump min Java requirement to 11. (#1242)
• BREAKING CHANGE: Move tracking unused classes logic out ofShadowCopyAction. (#1257)
• Reduce duplicatedSimpleRelocator to improve performance. (#1271)
• BREAKING CHANGE: MoveDependencyFilter intotasks package. (#1272)
• BREAKING CHANGE: Change the defaultduplicatesStrategy fromEXCLUDE toINCLUDE. (#1233)
  • ShadowJar recognizedDuplicatesStrategy.EXCLUDE as the default, but the other strategies didn't work properly.
  • NowShadowJar honorsDuplicatesStrategy.INCLUDE as the default, and align all the strategy behaviors with the Gradle side.
• BREAKING CHANGE: Align the behavior ofShadowTask.from with Gradle'sAbstractCopyTask.from. (#1233)
  In the previous versions,ShadowTask.from would always unzip the files before processing them, which caused serial
  issues that are hard to fix. Now it behaves like Gradle'sAbstractCopyTask.from, which means it will not unzip
  the files, only copy the files as-is. If you still want to shadow the unzipped files, try out something like:

    tasks.shadowJar {    from(zipTree(files('path/to/your/file.zip')))  }

  or

    dependencies {    implementation(files('path/to/your/file.zip'))  }

• BREAKING CHANGE: RenameTransformer toResourceTransformer. (#1288)
  Aims to better align with the nameorg.apache.maven.plugins.shade.resource.ResourceTransformer.java
  and to distinguish itself fromorg.gradle.api.Transformer.java.
• BREAKING CHANGE: MarkDefaultInheritManifest asinternal. (#1303)
• BREAKING CHANGE: PolishShadowSpec. (#1307)
  • Return values ofShadowSpec functions are changed toUnit to avoid confusion.
  • ShadowSpec no longer extendsCopySpec.
  • Overloadrelocate,transform and things for better usability in Kotlin.
• BREAKING CHANGE: Remove redundant types from function returning. (#1308)
• Replace deprecatedSelfResolvingDependency withFileCollectionDependency. (#1114)
• Update start script templates. (#1183)
• Mark moreTransformers cacheable. (#1210)
• MarkShadowJar.dependencyFilter as@Input. (#1206)
• PolishstartShadowScripts task registering. (#1216)
• Refactor file visiting logic inStreamAction, handle file unzipping viaProject.zipTree. (#1233)
• Migrate doc sites to MkDocs. (#1302)
• runShadow no longer depends oninstallShadowDist. (#1353)
• Move the group ofShadowJar fromshadow tobuild. (#1355)
• In-development snapshots are now published to the Central Portal Snapshots repository. (#1414)

Fixed

• Fix single Log4j2Plugins.dat isn't included into fat jar. (#1039)
• Fail builds if processing bad jars. (#1146)
• FixLog4j2PluginsCacheFileTransformer not working for mergingLog4j2Plugins.dat files. (#1175)
• Support overridingmainClass provided byJavaApplication. (#1182)
• FixShadowJar not being successful afterincludes orexcludes are changed. (#1200)
• HonorDuplicatesStrategy. (#1233)
• Honor unzipped jars viafrom. (#1233)
• Fix the last modified time of shadowed directories. (#1277)
• Fix relocation exclusion for file patterns likekotlin/kotlin.kotlin_builtins. (#1313)
• Allow using file trees of JARs together with the configuration cache. (#1441)

Removed

• BREAKING CHANGE: Remove Develocity integration. (#1014)
• BREAKING CHANGE: Some public getters and setters have been removed inSimpleRelocator. (#1079)
• BREAKING CHANGE: RemoveJavaJarExec, now useJavaExec directly forrunShadow task. (#1197)
• BREAKING CHANGE:ServiceFileTransformer.ServiceStream has been removed. (#1218)
• BREAKING CHANGE: RemoveKnowsTask as it's useless. (#1236)
• BREAKING CHANGE: RemoveBaseStreamAction. (#1258)
• BREAKING CHANGE: RemoveShadowStats. (#1264)
• BREAKING CHANGE: RemoveShadowCopyAction.ArchiveFileTreeElement andRelativeArchivePath. (#1233)
• BREAKING CHANGE: RemoveTransformerContext.getEntryTimestamp. (#1245)
• BREAKING CHANGE: Reduce dependency and project overloads inDependencyFilter. (#1328)

New Contributors

• @KurdTt made their first contribution in#1039
• @SimonMarquis made their first contribution in#1194
• @andsel made their first con...

Contributors