Skip to content

Add Kdoc for applying resource transformers #1885

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 4 commits into from
Dec 13, 2025
+36 −0
Merged

Add Kdoc for applying resource transformers #1885

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9200ca4
Add Kdoc for applying resource transformers
Goooler Dec 10, 2025
cd831db
Update src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/tas…
Goooler Dec 10, 2025
0e794bb
Merge remote-tracking branch 'origin/main' into g/20251210/kdoc-for-s…
Goooler Dec 12, 2025
ff51267
Mention `Handling Duplicates Strategy`
Goooler Dec 12, 2025
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
36 changes: 36 additions & 0 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 @@ -294,13 +294,25 @@ public abstract class ShadowJar : Jar() {

/**
* Merge Java services files with [rootPath].
*
* *Warning*: In most cases, this should be used with the correct [getDuplicatesStrategy] to ensure duplicate service
Copy link

@Tapchicoma Tapchicoma Dec 11, 2025

Choose a reason for hiding this comment

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

Could you also provide here a link to the documentation: https://gradleup.com/shadow/configuration/merging/#handling-duplicates-strategy ?

Copy link
Member Author

@Goooler Goooler Dec 12, 2025

Choose a reason for hiding this comment

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

ff51267

* files are handled properly. See more details in the
* [Handling Duplicates Strategy](https://gradleup.com/shadow/configuration/merging/#handling-duplicates-strategy) section.
*
* @see [getDuplicatesStrategy]
*/
public open fun mergeServiceFiles(rootPath: String) {
mergeServiceFiles { it.path = rootPath }
}

/**
* Merge Java services files with [action].
*
* *Warning*: In most cases, this should be used with the correct [getDuplicatesStrategy] to ensure duplicate service
* files are handled properly. See more details in the
* [Handling Duplicates Strategy](https://gradleup.com/shadow/configuration/merging/#handling-duplicates-strategy) section.
*
* @see [getDuplicatesStrategy]
*/
@JvmOverloads
public open fun mergeServiceFiles(action: Action<ServiceFileTransformer> = Action {}) {
Expand All @@ -309,6 +321,12 @@ public abstract class ShadowJar : Jar() {

/**
* Merge Groovy extension modules (`META-INF/**/org.codehaus.groovy.runtime.ExtensionModule`).
*
* *Warning*: In most cases, this should be used with the correct [getDuplicatesStrategy] to ensure duplicate extension module
* files are handled properly. See more details in the
* [Handling Duplicates Strategy](https://gradleup.com/shadow/configuration/merging/#handling-duplicates-strategy) section.
*
* @see [getDuplicatesStrategy]
*/
public open fun mergeGroovyExtensionModules() {
transform(GroovyExtensionModuleTransformer::class.java, action = {})
Expand Down Expand Up @@ -370,6 +388,12 @@ public abstract class ShadowJar : Jar() {

/**
* Transform resources using a [ResourceTransformer].
*
* *Warning*: Most of the [ResourceTransformer]s should be used with the correct [getDuplicatesStrategy] to ensure
* duplicate resource files are handled properly. See more details in the
* [Handling Duplicates Strategy](https://gradleup.com/shadow/configuration/merging/#handling-duplicates-strategy) section.
*
* @see [getDuplicatesStrategy]
*/
@JvmOverloads
public open fun <T : ResourceTransformer> transform(clazz: Class<T>, action: Action<T> = Action {}) {
Expand All @@ -378,6 +402,12 @@ public abstract class ShadowJar : Jar() {

/**
* Transform resources using a [ResourceTransformer].
*
* *Warning*: Most of the [ResourceTransformer]s should be used with the correct [getDuplicatesStrategy] to ensure
* duplicate resource files are handled properly. See more details in the
* [Handling Duplicates Strategy](https://gradleup.com/shadow/configuration/merging/#handling-duplicates-strategy) section.
*
* @see [getDuplicatesStrategy]
*/
@JvmOverloads
public open fun <T : ResourceTransformer> transform(transformer: T, action: Action<T> = Action {}) {
Expand All @@ -386,6 +416,12 @@ public abstract class ShadowJar : Jar() {

/**
* Transform resources using a [ResourceTransformer].
*
* *Warning*: Most of the [ResourceTransformer]s should be used with the correct [getDuplicatesStrategy] to ensure
* duplicate resource files are handled properly. See more details in the
* [Handling Duplicates Strategy](https://gradleup.com/shadow/configuration/merging/#handling-duplicates-strategy) section.
*
* @see [getDuplicatesStrategy]
*/
@JvmSynthetic
public inline fun <reified T : ResourceTransformer> transform(action: Action<T> = Action {}) {
Expand Down