Skip to content

Document missing resource transformers - #2199

Merged
Goooler merged 10 commits into
mainfrom
g/20260817/add-docs
Aug 23, 2026
Merged

Document missing resource transformers#2199
Goooler merged 10 commits into
mainfrom
g/20260817/add-docs

Conversation

@Goooler

@Goooler Goooler commented Aug 17, 2026

Copy link
Copy Markdown
Member

No description provided.

@Goooler
Goooler force-pushed the g/20260817/add-docs branch from d3ff35a to 22ac8d1 Compare August 23, 2026 08:21
@Goooler Goooler changed the title Document missing resource transformers and fix manifest transformers Document missing resource transformers Aug 23, 2026
@Goooler
Goooler marked this pull request as ready for review August 23, 2026 12:14

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 via tasks.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, resource is a Gradle Property<String> on XmlAppendingTransformer; 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.

Comment thread docs/configuration/merging/README.md
Comment thread docs/configuration/merging/README.md
Comment thread docs/configuration/merging/README.md
Comment thread docs/configuration/merging/README.md
@Goooler
Goooler merged commit 59e4eb4 into main Aug 23, 2026
7 checks passed
@Goooler
Goooler deleted the g/20260817/add-docs branch August 23, 2026 12:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants