Merge remote-tracking branch 'origin/main' into g/20250311/kotlin-new-app-block

Goooler · Goooler · commit c566f2737072 · 2025-03-24T14:04:03.000+08:00
diff --git a/README.md b/README.md
@@ -29,6 +29,6 @@ Gradle plugin for creating fat/uber JARs with support for package relocation.
 | 5.2.0 - 6.1.0  | 5.x - 6.x          | 7                |
 | 6.1.0+         | 6.x                | 8                |
 | 7.0.0+         | 7.x                | 8                |
-| 8.0.0+         | 8.0+               | 8                |
-| 8.3.0+         | 8.3+               | 8                |
-| 9.0.0+         | 8.3+               | 11               |
+| 8.0.0+         | 8.0                | 8                |
+| 8.3.0+         | 8.3                | 8                |
+| 9.0.0+         | 8.3                | 11               |
diff --git a/api/shadow.api b/api/shadow.api
@@ -4,7 +4,6 @@ public abstract class com/github/jengelman/gradle/plugins/shadow/ShadowBasePlugi
 	public static final field Companion Lcom/github/jengelman/gradle/plugins/shadow/ShadowBasePlugin$Companion;
 	public static final field DISTRIBUTION_NAME Ljava/lang/String;
 	public static final field EXTENSION_NAME Ljava/lang/String;
-	public static final field GROUP_NAME Ljava/lang/String;
 	public static final field SHADOW Ljava/lang/String;
 	public fun <init> ()V
 	public synthetic fun apply (Ljava/lang/Object;)V
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -147,6 +147,11 @@ tasks.pluginUnderTestMetadata {
   )
 }
 
+tasks.validatePlugins {
+  // TODO: https://github.com/gradle/gradle/issues/22600
+  enableStricterValidation = true
+}
+
 tasks.check {
   dependsOn(tasks.withType<Test>())
 }
diff --git a/docs/changes/README.md b/docs/changes/README.md
@@ -3,6 +3,13 @@
 
 ## [Unreleased]
 
+**Changed**
+
+- Move the group of `ShadowJar` from `shadow` to `build`. ([#1355](https://github.com/GradleUp/shadow/pull/1355))
+
+
+## [v9.0.0-beta11] (2025-03-18)
+
 **Added**
 
 - Add Kotlin DSL examples in docs. ([#1306](https://github.com/GradleUp/shadow/pull/1306))
@@ -609,7 +616,8 @@ Instead, use the `enableRelocation = true` and `relocationPrefix = "<new package
 
 
 
-[Unreleased]: https://github.com/GradleUp/shadow/compare/9.0.0-beta10...HEAD
+[Unreleased]: https://github.com/GradleUp/shadow/compare/9.0.0-beta11...HEAD
+[v9.0.0-beta11]: https://github.com/GradleUp/shadow/releases/tag/9.0.0-beta11
 [v9.0.0-beta10]: https://github.com/GradleUp/shadow/releases/tag/9.0.0-beta10
 [v9.0.0-beta9]: https://github.com/GradleUp/shadow/releases/tag/9.0.0-beta9
 [v9.0.0-beta8]: https://github.com/GradleUp/shadow/releases/tag/9.0.0-beta8
diff --git a/docs/configuration/README.md b/docs/configuration/README.md
@@ -4,10 +4,10 @@ api: api/com/github/jengelman/gradle/plugins/shadow
 
 # Configuring Shadow
 
-The [`ShadowJar`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task type extends from Gradle's
+The [`ShadowJar`](../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task type extends from Gradle's
 [`Jar`](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html) type.
 This means that all attributes and methods available on `Jar` are also available on
-[`ShadowJar`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html).
+[`ShadowJar`](../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html).
 Refer the _Gradle User Guide_ for [Jar](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html) for
 details.
 
diff --git a/docs/configuration/dependencies/README.md b/docs/configuration/dependencies/README.md
@@ -3,7 +3,7 @@
 Shadow configures the default `shadowJar` task to merge all dependencies from the project's `runtimeClasspath` configuration
 into the final JAR.
 The configurations from which to source dependencies for the merging can be configured using the `configurations` property
-of the [`ShadowJar`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task type.
+of the [`ShadowJar`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task type.
 
 === "Kotlin"
 
@@ -25,9 +25,9 @@ The above code sample would configure the `shadowJar` task to merge dependencies
 This means any dependency declared in the `runtimeOnly` configuration would be **not** be included in the final JAR.
 
 > Note the literal use of `project.configurations` when setting the `configurations` attribute of a
-[`ShadowJar`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task.
+[`ShadowJar`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task.
 This is **required**. It may be tempting to specify `configurations = [configurations.compile]` but this will not
-have the intended effect, as `configurations.compile` will try to delegate to the `configurations` property of the [`ShadowJar`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task instead of the `project`
+have the intended effect, as `configurations.compile` will try to delegate to the `configurations` property of the [`ShadowJar`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task instead of the `project`
 
 ## Embedding Jar Files Inside Your Shadow Jar
 
@@ -72,7 +72,7 @@ See also [Adding Extra Files](../README.md#adding-extra-files)
 ## Filtering Dependencies
 
 Individual dependencies can be filtered from the final JAR by using the `dependencies` block of a
-[`ShadowJar`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task.
+[`ShadowJar`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task.
 Dependency filtering does **not** apply to transitive dependencies.
 That is, excluding a dependency does not exclude any of its dependencies from the final JAR.
 
@@ -306,7 +306,7 @@ You can also use type-safe project accessors or version catalog accessors to fil
 ### Programmatically Selecting Dependencies to Filter
 
 If more complex decisions are needed to select the dependencies to be included, the
-[`dependencies`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/dependencies.html)
+[`dependencies`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/dependencies.html)
 block provides a method that accepts a `Closure` for selecting dependencies.
 
 === "Kotlin"
diff --git a/docs/configuration/merging/README.md b/docs/configuration/merging/README.md
@@ -1,11 +1,11 @@
 # Controlling JAR Content Merging
 
 Shadow allows for customizing the process by which the output JAR is generated through the
-[`ResourceTransformer`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-resource-transformer/index.html) interface.
+[`ResourceTransformer`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-resource-transformer/index.html) interface.
 This is a concept that has been carried over from the original Maven Shade implementation.
-A [`ResourceTransformer`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-resource-transformer/index.html) is invoked for each 
+A [`ResourceTransformer`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-resource-transformer/index.html) is invoked for each 
 entry in the JAR before being written to the final output JAR.
-This allows a [`ResourceTransformer`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-resource-transformer/index.html) to 
+This allows a [`ResourceTransformer`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-resource-transformer/index.html) to 
 determine if it should process a particular entry and apply any modifications before writing the stream to the output.
 
 === "Kotlin"
@@ -147,7 +147,7 @@ At runtime, this file is read and used to configure library or application behav
 
 Multiple dependencies may use the same service descriptor file name.
 In this case, it is generally desired to merge the content of each instance of the file into a single output file.
-The [`ServiceFileTransformer`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-service-file-transformer/index.html) 
+The [`ServiceFileTransformer`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-service-file-transformer/index.html) 
 class is used to perform this merging. By default, it will merge each copy of a file under `META-INF/services` into a 
 single file in the output JAR.
 
@@ -168,17 +168,17 @@ single file in the output JAR.
     ```
 
 The above code snippet is a convenience syntax for calling
-[`transform(ServiceFileTransformer.class)`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/transform.html).
+[`transform(ServiceFileTransformer.class)`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/transform.html).
 
 > Groovy Extension Module descriptor files (located at `META-INF/services/org.codehaus.groovy.runtime.ExtensionModule`)
-are ignored by the [`ServiceFileTransformer`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-service-file-transformer/index.html).
+are ignored by the [`ServiceFileTransformer`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-service-file-transformer/index.html).
 This is due to these files having a different syntax than standard service descriptor files.
-Use the [`mergeGroovyExtensionModules()`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/merge-groovy-extension-modules.html) method to merge
+Use the [`mergeGroovyExtensionModules()`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/merge-groovy-extension-modules.html) method to merge
 these files if your dependencies contain them.
 
 ### Configuring the Location of Service Descriptor Files
 
-By default, the [`ServiceFileTransformer`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-service-file-transformer/index.html) 
+By default, the [`ServiceFileTransformer`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-service-file-transformer/index.html) 
 is configured to merge files in `META-INF/services`.
 This directory can be overridden to merge descriptor files in a different location.
 
@@ -202,9 +202,9 @@ This directory can be overridden to merge descriptor files in a different locati
     }
     ```
 
-#### Excluding/Including Specific Service Descriptor Files From Merging
+### Excluding/Including Specific Service Descriptor Files From Merging
 
-The [`ServiceFileTransformer`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-service-file-transformer/index.html) 
+The [`ServiceFileTransformer`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-service-file-transformer/index.html) 
 class supports specifying specific files to include or exclude from merging.
 
 === "Kotlin"
@@ -231,9 +231,9 @@ class supports specifying specific files to include or exclude from merging.
 
 Shadow provides a specific transformer for dealing with Groovy extension module files.
 This is due to their special syntax and how they need to be merged together.
-The [`GroovyExtensionModuleTransformer`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-groovy-extension-module-transformer/index.html) 
+The [`GroovyExtensionModuleTransformer`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-groovy-extension-module-transformer/index.html) 
 will handle these files.
-The [`ShadowJar`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task also provides a short syntax 
+The [`ShadowJar`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task also provides a short syntax 
 method to add this transformer.
 
 === "Kotlin"
@@ -276,11 +276,11 @@ containing Log4j 2.x Core components. It's a Gradle equivalent of [Log4j Plugin
 ## Appending Text Files
 
 Generic text files can be appended together using the
-[`AppendingTransformer`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-appending-transformer/index.html).
+[`AppendingTransformer`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-appending-transformer/index.html).
 Each file is appended using separators (defaults to `\n`) to separate content.
-The [`ShadowJar`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task provides a short syntax 
+The [`ShadowJar`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task provides a short syntax 
 method of
-[`append(String)`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/append.html) to 
+[`append(String)`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/append.html) to 
 configure this transformer.
 
 === "Kotlin"
@@ -331,10 +331,10 @@ configure this transformer.
 ## Appending XML Files
 
 XML files require a special transformer for merging.
-The [`XmlAppendingTransformer`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-xml-appending-transformer/index.html) 
+The [`XmlAppendingTransformer`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-xml-appending-transformer/index.html) 
 reads each XML document and merges each root element into a single document.
-There is no short syntax method for the [`XmlAppendingTransformer`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-xml-appending-transformer/index.html).
-It must be added using the [`transform`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/transform.html)) methods.
+There is no short syntax method for the [`XmlAppendingTransformer`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.transformers/-xml-appending-transformer/index.html).
+It must be added using the [`transform`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/transform.html)) methods.
 
 === "Kotlin"
 
diff --git a/docs/custom-tasks/README.md b/docs/custom-tasks/README.md
@@ -1,15 +1,15 @@
 # Creating a Custom ShadowJar Task
 
 The built in `shadowJar` task only provides an output for the `main` source set of the project.
-It is possible to add arbitrary [`ShadowJar`](https://gradleup.com/shadow/api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) 
+It is possible to add arbitrary [`ShadowJar`](../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) 
 tasks to a project. When doing so, ensure that the `configurations` property is specified to inform Shadow which 
 dependencies to merge into the output.
 
 === "Kotlin"
 
     ```kotlin
     val testShadowJar by tasks.registering(com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar::class) {
-      group = com.github.jengelman.gradle.plugins.shadow.ShadowBasePlugin.GROUP_NAME
+      group = LifecycleBasePlugin.BUILD_GROUP
       description = "Create a combined JAR of project and test dependencies"
 
       archiveClassifier = "tests"
@@ -33,7 +33,7 @@ dependencies to merge into the output.
 
     ```groovy
     def testShadowJar = tasks.register('testShadowJar', com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar) {
-      group = com.github.jengelman.gradle.plugins.shadow.ShadowBasePlugin.GROUP_NAME
+      group = LifecycleBasePlugin.BUILD_GROUP
       description = 'Create a combined JAR of project and test dependencies'
 
       archiveClassifier = 'tests'
diff --git a/docs/publishing/README.md b/docs/publishing/README.md
@@ -163,7 +163,7 @@ It is possible to publish a custom `ShadowJar` task's output via the [`MavenPubl
     }
 
     val testShadowJar by tasks.registering(com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar::class) {
-      group = com.github.jengelman.gradle.plugins.shadow.ShadowBasePlugin.GROUP_NAME
+      group = LifecycleBasePlugin.BUILD_GROUP
       description = "Create a combined JAR of project and test dependencies"
       archiveClassifier = "tests"
       from(sourceSets.test.map { it.output })
@@ -196,7 +196,7 @@ It is possible to publish a custom `ShadowJar` task's output via the [`MavenPubl
     }
 
     def testShadowJar = tasks.register('testShadowJar', com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar) {
-      group = com.github.jengelman.gradle.plugins.shadow.ShadowBasePlugin.GROUP_NAME
+      group = LifecycleBasePlugin.BUILD_GROUP
       description = 'Create a combined JAR of project and test dependencies'
       archiveClassifier = 'tests'
       from sourceSets.named('test').map { it.output }
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -1,5 +1,5 @@
 [versions]
-kotlin = "2.1.20-RC3"
+kotlin = "2.1.20"
 moshi = "1.15.2"
 
 [libraries]
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -22,7 +22,7 @@ develocity {
   buildScan {
     termsOfUseUrl = "https://gradle.com/terms-of-service"
     termsOfUseAgree = "yes"
-    // TODO: workaround for https://github.com/gradle/gradle/issues/22879.
+    // TODO: https://github.com/gradle/gradle/issues/22879
     val isCI = providers.environmentVariable("CI").isPresent
     publishing.onlyIf { isCI }
   }
diff --git a/src/documentTest/kotlin/com/github/jengelman/gradle/plugins/shadow/snippet/CodeSnippetExtractor.kt b/src/documentTest/kotlin/com/github/jengelman/gradle/plugins/shadow/snippet/CodeSnippetExtractor.kt
@@ -5,7 +5,6 @@ import java.util.regex.Pattern
 import kotlin.io.path.ExperimentalPathApi
 import kotlin.io.path.Path
 import kotlin.io.path.name
-import kotlin.io.path.pathString
 import kotlin.io.path.readText
 import kotlin.io.path.relativeTo
 import kotlin.io.path.walk
@@ -28,7 +27,7 @@ object CodeSnippetExtractor {
     lang: DslLang,
     markdownPath: Path,
   ): List<SnippetExecutable> {
-    val relativeDocPath = markdownPath.relativeTo(docRoot).pathString
+    val relativeDocPath = markdownPath.relativeTo(docRoot).toString()
     return createSnippets(markdownPath.readText(), lang).map { (lineNumber, snippet) ->
       SnippetExecutable.create(
         lang,
diff --git a/src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/JavaPluginTest.kt b/src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/JavaPluginTest.kt
@@ -475,7 +475,7 @@ class JavaPluginTest : BasePluginTest() {
           testImplementation 'junit:junit:3.8.2'
         }
         def $testShadowJarTask = tasks.register('$testShadowJarTask', ${ShadowJar::class.java.name}) {
-          group = com.github.jengelman.gradle.plugins.shadow.ShadowBasePlugin.GROUP_NAME
+          group = LifecycleBasePlugin.BUILD_GROUP
           description = 'Create a combined JAR of project and test dependencies'
           archiveClassifier = 'tests'
           from sourceSets.named('test').map { it.output }
diff --git a/src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/PublishingTest.kt b/src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/PublishingTest.kt
@@ -148,7 +148,7 @@ class PublishingTest : BasePluginTest() {
       publishConfiguration(
         projectBlock = """
           def testShadowJar = tasks.register('testShadowJar', ${ShadowJar::class.java.name}) {
-            group = com.github.jengelman.gradle.plugins.shadow.ShadowBasePlugin.GROUP_NAME
+            group = LifecycleBasePlugin.BUILD_GROUP
             description = 'Create a combined JAR of project and test dependencies'
             archiveClassifier = 'tests'
             from sourceSets.named('test').map { it.output }
diff --git a/src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/util/JarPath.kt b/src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/util/JarPath.kt
@@ -25,6 +25,8 @@ class JarPath(val path: Path) :
   fun getMainAttr(name: String): String? {
     return manifest.mainAttributes.getValue(name)
   }
+
+  override fun toString(): String = path.toString()
 }
 
 fun ZipFile.getContent(entryName: String): String {
diff --git a/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/ShadowBasePlugin.kt b/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/ShadowBasePlugin.kt
@@ -21,7 +21,6 @@ public abstract class ShadowBasePlugin : Plugin<Project> {
 
   public companion object {
     public const val SHADOW: String = "shadow"
-    public const val GROUP_NAME: String = SHADOW
     public const val EXTENSION_NAME: String = SHADOW
     public const val CONFIGURATION_NAME: String = SHADOW
     public const val COMPONENT_NAME: String = SHADOW
diff --git a/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/ShadowJavaPlugin.kt b/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/ShadowJavaPlugin.kt

Original file line number	Diff line number	Diff line change
`@@ -147,6 +147,11 @@ tasks.pluginUnderTestMetadata {`
`147`	`147`	`)`
`148`	`148`	`}`
`149`	`149`
	`150`	`+tasks.validatePlugins {`
	`151`	`+ // TODO: https://github.com/gradle/gradle/issues/22600`
	`152`	`+ enableStricterValidation = true`
	`153`	`+}`
	`154`	`+`
`150`	`155`	`tasks.check {`
`151`	`156`	`dependsOn(tasks.withType<Test>())`
`152`	`157`	`}`