Skip to content

Deprecate minimizeJar property #2124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Goooler merged 1 commit into from
Jul 27, 2026
+18 −9
Merged

Deprecate minimizeJar property #2124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/changes/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
### Deprecated

- Deprecate `keepRules` and `keepRuleFiles` in `R8Spec`. ([#2120](https://github.com/GradleUp/shadow/pull/2120))
- Deprecate `ShadowJar.minimizeJar`; call `ShadowJar.minimize()` explicitly instead. ([#2124](https://github.com/GradleUp/shadow/pull/2124))
The property will be made non-public in Shadow 10.

## [9.6.1](https://github.com/GradleUp/shadow/releases/tag/9.6.1) - 2026-07-22

Expand Down
23 changes: 15 additions & 8 deletions src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,10 @@ public abstract class ShadowJar : Jar() {
*
* Defaults to `false`.
*/
@Deprecated(
message = "Use `minimize()` instead. This property will be made non-public in Shadow 10.",
replaceWith = ReplaceWith("minimize()"),
)
Comment thread
Goooler marked this conversation as resolved.
@get:Input
@get:Option(
option = "minimize-jar",
Expand All @@ -115,20 +119,20 @@ public abstract class ShadowJar : Jar() {

@get:Classpath
public open val toMinimize: ConfigurableFileCollection = objectFactory.fileCollection {
minimizeJar.map {
_minimizeJar.map {
if (it) (defaultMinimizeSpec.resolve(configurations.get()) - apiJars) else emptySet()
}
}

@get:Classpath
public open val apiJars: ConfigurableFileCollection = objectFactory.fileCollection {
minimizeJar.map { if (it) project.getApiJars() else emptySet<File>() }
_minimizeJar.map { if (it) project.getApiJars() else emptySet<File>() }
}

@get:InputFiles
@get:PathSensitive(PathSensitivity.RELATIVE)
public open val sourceSetsClassesDirs: ConfigurableFileCollection = objectFactory.fileCollection {
minimizeJar.map {
_minimizeJar.map {
if (it) {
project.sourceSets.map { sourceSet ->
sourceSet.output.classesDirs.filter(File::isDirectory)
Expand All @@ -141,7 +145,7 @@ public abstract class ShadowJar : Jar() {

@get:Classpath
public open val r8Classpath: ConfigurableFileCollection = objectFactory.fileCollection {
minimizeJar.zip(minimizeSpec.tool) { enabled, tool ->
_minimizeJar.zip(minimizeSpec.tool) { enabled, tool ->
if (enabled && tool == MinimizeTool.R8) {
// Use findByName so custom ShadowJar tasks can be configured even when shadowR8 isn't
// registered.
Expand Down Expand Up @@ -331,10 +335,10 @@ public abstract class ShadowJar : Jar() {

@get:Inject protected abstract val archiveOperations: ArchiveOperations

/** Enable [minimizeJar] and execute the [action] with the [MinimizeSpec] for minimize. */
/** Enable minimization and execute the [action] with the [MinimizeSpec] for minimize. */
@JvmOverloads
public open fun minimize(action: Action<in MinimizeSpec> = Action {}) {
minimizeJar.set(true)
_minimizeJar.set(true)
action.execute(minimizeSpec)
}

Expand Down Expand Up @@ -531,7 +535,7 @@ public abstract class ShadowJar : Jar() {
}
}
val unusedClasses =
if (minimizeJar.get() && minimizeSpec.tool.get() == MinimizeTool.DEPENDENCY_ANALYZER) {
if (_minimizeJar.get() && minimizeSpec.tool.get() == MinimizeTool.DEPENDENCY_ANALYZER) {
val unusedTracker =
UnusedTracker(
sourceSetsClassesDirs = sourceSetsClassesDirs.files,
Expand Down Expand Up @@ -578,6 +582,9 @@ public abstract class ShadowJar : Jar() {
transformers.add(transformer)
}

private val _minimizeJar
get() = @Suppress("DEPRECATION") minimizeJar

private val packageRelocators: List<SimpleRelocator>
get() {
if (enableAutoRelocation.get()) {
Expand Down Expand Up @@ -702,7 +709,7 @@ public abstract class ShadowJar : Jar() {
}

private fun minimizeWithR8() {
val useR8 = minimizeJar.get() && minimizeSpec.tool.get() == MinimizeTool.R8
val useR8 = _minimizeJar.get() && minimizeSpec.tool.get() == MinimizeTool.R8
if (!useR8) return
val keptDependencyFiles = includedDependencies.files - toMinimize.files
R8Minimizer(
Expand Down
2 changes: 1 addition & 1 deletion src/test/kotlin/com/github/jengelman/gradle/plugins/shadow/ShadowPropertiesTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ class ShadowPropertiesTest {
assertThat(enableAutoRelocation.get()).isFalse()
@Suppress("DEPRECATION") assertThat(enableKotlinModuleRemapping.get()).isTrue()
assertThat(failOnDuplicateEntries.get()).isFalse()
assertThat(minimizeJar.get()).isFalse()
@Suppress("DEPRECATION") assertThat(minimizeJar.get()).isFalse()
assertThat(mainClass.orNull).isNull()
assertThat(javaLauncher.get().metadata.jvmVersion)
.isEqualTo(
Expand Down