RFC: New transformers #1848

snazy · 2025-11-15T11:53:25Z

@Goooler I've created a couple new transformers. Would you mind taking a look which ones you think make sense for the project? I would then create individual PRs including tests for each of those.

Deduplicating transformer - to include the same path for the same content only once, detects conflicts
Merge property files transformer - to merge the properties of property files with the same path, detecting conflicts
Merge license files transformer - to produce a license with with the project's license and the license files from the dependencies (but yea, no info about the actual Maven GAV)
Enhance the Apache Notice transformer to make the output-path and source file patterns configurable
Tool/convenience task to find dependencies that contain a matching pattern-filterable to debug conflicts.
Helper class for the above task + transformers (hide boilerplate code)

Goooler · 2025-11-15T12:00:49Z

.../com/github/jengelman/gradle/plugins/shadow/transformers/DeduplicatingResourceTransformer.kt

+ * Multiple files with the same path but different content lead to an error.
+ */
+@CacheableTransformer
+public open class DeduplicatingResourceTransformer


Part of a duplicate of #1548.

Kind of, except that it validates that the content's the same.

Maybe extend the existing one?

You can add new properties and new logic to that transformer.

I realized that PropertiesFileTransformer may not be suitable for reproducible builds, as it relies on j,u.Hashtable (the order of map entries isn't deterministic). Let me see what can be done about that.

Goooler · 2025-11-15T12:01:52Z

...n/com/github/jengelman/gradle/plugins/shadow/transformers/ApacheNoticeResourceTransformer.kt

 public open class ApacheNoticeResourceTransformer @Inject constructor(
  final override val objectFactory: ObjectFactory,
-) : ResourceTransformer {
+) : WithPatternFilterable(


Forgot to revert changes in ApacheNoticeResourceTransformer?

Not really. I found some dependencies with a legit NOTICE file, with the path /NOTICE (not in META-INF/).
So the idea was to keep the existing patterns, but allow users to override the defaults.

I misread... We can extract a common pattern class for these, inspired by #1848 (comment)

Ref to #1850 for the migration.

So the idea was to keep the existing patterns, but allow users to override the defaults.

Users can use include/setIncludes to do so. Noted include/exclude magic in #1850, may note setIncludes/setExcludes too.

Goooler · 2025-11-15T12:02:14Z

...n/com/github/jengelman/gradle/plugins/shadow/transformers/MergeLicenseResourceTransformer.kt

+ */
+@Suppress("unused")
+@CacheableTransformer
+public open class MergeLicenseResourceTransformer @Inject constructor(objectFactory: ObjectFactory) :


Fine to add.

You can create a PR for this first.

This could be addressed into a separate PR for now.

...om/github/jengelman/gradle/plugins/shadow/transformers/MergePropertiesResourceTransformer.kt

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/internal/WithPatternFilterable.kt

...n/com/github/jengelman/gradle/plugins/shadow/transformers/ApacheNoticeResourceTransformer.kt

snazy · 2025-11-17T11:49:11Z

(Just maintaining the branch for this draft PR as a "collection of things to split out".)

aka: "which dependencies contain the path XYZ"

Goooler reviewed Nov 15, 2025

View reviewed changes

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/internal/WithPatternFilterable.kt Outdated Show resolved Hide resolved

This was referenced Nov 15, 2025

Add PatternFilterableResourceTransformer and expose patternSet #1849

Merged

Support patternSet for license and notice transformers #1850

Merged

Support overriding output path of ApacheNoticeResourceTransformer #1851

Merged

Goooler reviewed Nov 17, 2025

View reviewed changes

...n/com/github/jengelman/gradle/plugins/shadow/transformers/ApacheNoticeResourceTransformer.kt Outdated Show resolved Hide resolved

snazy force-pushed the all-the-transformers branch 3 times, most recently from b70a321 to 665583e Compare November 17, 2025 11:45

snazy force-pushed the all-the-transformers branch from 665583e to 93c8ba8 Compare November 17, 2025 12:09

This was referenced Nov 17, 2025

Add pattern-filterable to PreserveFirstFoundResourceTransformer #1855

Merged

Add new merge strategy Fail to PropertiesFileTransformer #1856

Merged

snazy force-pushed the all-the-transformers branch from 93c8ba8 to 7475920 Compare November 17, 2025 13:26

snazy added 6 commits November 17, 2025 18:02

PreserveFirstFoundResourceTransformer smoke test

0f83ab3

PropertiesFileTransformer - add MergeStrategy.Fail

81f6089

PropertiesFileTransformer - make merged properties reproducible

ef9ac07

Add a convenience task to find resources in dependencies

5d956f3

aka: "which dependencies contain the path XYZ"

Add transformer to deduplicate identical files based content

d9ce81a

Add transformer to merge licenses into a single license file

6b91178

snazy force-pushed the all-the-transformers branch from 7475920 to 6b91178 Compare November 17, 2025 17:12

snazy closed this Nov 17, 2025

This was referenced Nov 18, 2025

Add transformer to merge licenses into a single license file #1858

Open

Add FindResourceInClasspath task to find resources in dependencies #1860

Merged

PropertiesFileTransformer - make merged properties reproducible #1861

Open

Uh oh!

RFC: New transformers #1848

RFC: New transformers #1848

Uh oh!

Conversation

snazy commented Nov 15, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Goooler Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

snazy commented Nov 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Goooler Nov 17, 2025 •

edited

Loading