Document missing resource transformers - #2199
Merged
Merged
Conversation
Goooler
force-pushed
the
g/20260817/add-docs
branch
from
August 23, 2026 08:21
d3ff35a to
22ac8d1
Compare
…d pattern filtering
Goooler
marked this pull request as ready for review
August 23, 2026 12:14
…ertiesFileTransformer
…for PropertiesFileTransformer" This reverts commit 426b26d.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Shadow’s documentation to better cover “missing” resource transformers and modernize Gradle DSL examples (Kotlin/Groovy) for configuring resource merging and transformations.
Changes:
- Modernizes
transform(...)usage examples (Kotlin trailing-lambda style, Groovy configuration avoidance viatasks.named). - Expands documentation for additional transformers (e.g., Properties merging, Apache NOTICE, Plexus components XML, deduplication/preserve-first semantics).
- Adds/updates API reference links for newly documented transformers and constants.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/kotlin-plugins/README.md | Updates Kotlin/Groovy examples for Kotlin module metadata transformer configuration. |
| docs/configuration/merging/README.md | Modernizes transform examples and adds/expands sections documenting additional built-in resource transformers and configuration patterns. |
Suppressed comments (2)
docs/configuration/merging/README.md:555
- In Kotlin DSL,
resourceis a GradleProperty<String>onXmlAppendingTransformer; configure it via.set(...)instead of=.
transform<com.github.jengelman.gradle.plugins.shadow.transformers.XmlAppendingTransformer> {
resource = "properties.xml"
}
docs/configuration/merging/README.md:752
- In Kotlin DSL, these transformer fields are Gradle
Property<String>values; assigning with=won’t compile. Use.set(...)for each property.
projectName = "My Project"
organizationName = "My Organization"
organizationURL = "https://example.com"
inceptionYear = "2024"
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.