[Plugin] Remove ktx-related code from build scripts (#7122)

rlazo · web-flow · commit a9fa4e16b7e7 · 2025-07-08T19:15:21.000-04:00
All ktx related functionality has been merged to the main libraries, and the KTX-only code removed. See #7106
diff --git a/appcheck/firebase-appcheck-debug-testing/firebase-appcheck-debug-testing.gradle b/appcheck/firebase-appcheck-debug-testing/firebase-appcheck-debug-testing.gradle
@@ -23,7 +23,6 @@ firebaseLibrary {
     releaseNotes {
         name.set("{{app_check}} Debug Testing")
         versionName.set("appcheck-debug-testing")
-        hasKTX.set(false)
     }
 }
 
diff --git a/appcheck/firebase-appcheck-debug/firebase-appcheck-debug.gradle b/appcheck/firebase-appcheck-debug/firebase-appcheck-debug.gradle
@@ -21,7 +21,6 @@ firebaseLibrary {
     releaseNotes {
         name.set("{{app_check}} Debug")
         versionName.set("appcheck-debug")
-        hasKTX.set(false)
     }
 }
 
diff --git a/appcheck/firebase-appcheck-playintegrity/firebase-appcheck-playintegrity.gradle b/appcheck/firebase-appcheck-playintegrity/firebase-appcheck-playintegrity.gradle
@@ -21,7 +21,6 @@ firebaseLibrary {
     releaseNotes {
         name.set("{{app_check}} Play integrity")
         versionName.set("appcheck-playintegrity")
-        hasKTX.set(false)
     }
 }
 
diff --git a/firebase-abt/firebase-abt.gradle b/firebase-abt/firebase-abt.gradle
@@ -22,7 +22,6 @@ firebaseLibrary {
     releaseNotes {
         name.set("{{ab_testing}}")
         versionName.set("ab_testing")
-        hasKTX.set(false)
     }
 }
 
diff --git a/firebase-ai/firebase-ai.gradle.kts b/firebase-ai/firebase-ai.gradle.kts
@@ -30,7 +30,6 @@ firebaseLibrary {
   releaseNotes {
     name.set("{{firebase_ai_logic}}")
     versionName.set("ai")
-    hasKTX.set(false)
   }
 }
 
diff --git a/firebase-appdistribution/firebase-appdistribution.gradle b/firebase-appdistribution/firebase-appdistribution.gradle
@@ -24,7 +24,6 @@ firebaseLibrary {
     releaseNotes {
         name.set("{{appdistro}}")
         versionName.set("app-distro")
-        hasKTX.set(false)
     }
 }
 
diff --git a/firebase-components/firebase-dynamic-module-support/firebase-dynamic-module-support.gradle.kts b/firebase-components/firebase-dynamic-module-support/firebase-dynamic-module-support.gradle.kts
@@ -22,7 +22,6 @@ firebaseLibrary {
   releaseNotes {
     name.set("Dynamic feature modules support")
     versionName.set("dynamic-feature-modules-support")
-    hasKTX.set(false)
   }
 }
 
diff --git a/firebase-crashlytics-ndk/firebase-crashlytics-ndk.gradle b/firebase-crashlytics-ndk/firebase-crashlytics-ndk.gradle
@@ -26,7 +26,6 @@ firebaseLibrary {
     releaseNotes {
         name.set("{{crashlytics}} NDK")
         versionName.set("crashlytics-ndk")
-        hasKTX.set(false)
     }
     testLab.enabled = true
     publishJavadoc = false
diff --git a/firebase-dataconnect/firebase-dataconnect.gradle.kts b/firebase-dataconnect/firebase-dataconnect.gradle.kts
@@ -31,7 +31,6 @@ firebaseLibrary {
   releaseNotes {
     name.set("{{data_connect_short}}")
     versionName.set("data-connect")
-    hasKTX.set(false)
   }
 }
 
diff --git a/firebase-messaging-directboot/firebase-messaging-directboot.gradle b/firebase-messaging-directboot/firebase-messaging-directboot.gradle
@@ -23,7 +23,6 @@ firebaseLibrary {
     releaseNotes {
         name.set("Cloud Messaging Direct Boot")
         versionName.set("messaging-directboot")
-        hasKTX.set(false)
     }
 }
 
diff --git a/firebase-sessions/firebase-sessions.gradle.kts b/firebase-sessions/firebase-sessions.gradle.kts
@@ -30,10 +30,7 @@ firebaseLibrary {
   testLab.enabled = true
   publishJavadoc = false
 
-  releaseNotes {
-    enabled = false
-    hasKTX = false
-  }
+  releaseNotes { enabled = false }
 }
 
 android {
diff --git a/firebase-vertexai/firebase-vertexai.gradle.kts b/firebase-vertexai/firebase-vertexai.gradle.kts
@@ -30,7 +30,6 @@ firebaseLibrary {
   releaseNotes {
     name.set("{{vertex_ai_in_firebase}}")
     versionName.set("vertex-ai")
-    hasKTX.set(false)
   }
 }
 
diff --git a/plugins/src/main/java/com/google/firebase/gradle/plugins/BaseFirebaseLibraryPlugin.kt b/plugins/src/main/java/com/google/firebase/gradle/plugins/BaseFirebaseLibraryPlugin.kt
@@ -75,7 +75,6 @@ abstract class BaseFirebaseLibraryPlugin : Plugin<Project> {
 
       releaseNotes {
         enabled.convention(true)
-        hasKTX.convention(true)
         artifactId.convention(project.name)
         artifactName.convention(project.name)
       }
diff --git a/plugins/src/main/java/com/google/firebase/gradle/plugins/MakeReleaseNotesTask.kt b/plugins/src/main/java/com/google/firebase/gradle/plugins/MakeReleaseNotesTask.kt
@@ -106,7 +106,7 @@ abstract class MakeReleaseNotesTask : DefaultTask() {
 
     val versionClassifier = version.replace(".", "-")
 
-    val baseReleaseNotes =
+    val releaseNotes =
       """
         |### ${config.name.get()} version $version {: #${config.versionName.get()}_v$versionClassifier}
         |
@@ -115,25 +115,6 @@ abstract class MakeReleaseNotesTask : DefaultTask() {
         .trimMargin()
         .trim()
 
-    val ktxReleaseNotes =
-      """
-          |#### ${config.name.get()} Kotlin extensions version $version {: #${config.versionName.get()}-ktx_v$versionClassifier}
-          |
-          |${unreleased.ktx?.toReleaseNotes() ?: KTXTransitiveReleaseText(project.name)}
-        """
-        .trimMargin()
-        .trim()
-        .takeIf { config.hasKTX.get() }
-
-    val releaseNotes =
-      """
-        |$baseReleaseNotes
-        |
-        |${ktxReleaseNotes.orEmpty()}
-      """
-        .trimMargin()
-        .trim()
-
     releaseNotesFile.asFile.get().writeText(releaseNotes + "\n")
   }
 
diff --git a/plugins/src/main/java/com/google/firebase/gradle/plugins/MoveUnreleasedChangesTask.kt b/plugins/src/main/java/com/google/firebase/gradle/plugins/MoveUnreleasedChangesTask.kt
@@ -78,31 +78,7 @@ abstract class MoveUnreleasedChangesTask : DefaultTask() {
     if (!unreleased.hasContent())
       throw StopActionException("No changes to move for project: ${project.name}")
 
-    return unreleased.copy(version = releaseVersion.get(), ktx = createEntryForKTX(unreleased))
-  }
-
-  /**
-   * Creates the [ReleaseEntry.ktx] for a new release.
-   *
-   * Ensures the entry is only created if the library has a KTX lib to begin with, and adds template
-   * subtext if it lacks any changes.
-   *
-   * @see ReleaseNotesConfigurationExtension
-   * @see KTXTransitiveReleaseText
-   */
-  private fun createEntryForKTX(release: ReleaseEntry): ReleaseContent? {
-    val releaseNotesConfig = project.firebaseLibrary.releaseNotes
-
-    val nonEmptyKTXContent = release.ktx?.takeIf { it.hasContent() }
-
-    val ktxContent =
-      nonEmptyKTXContent
-        ?: ReleaseContent(
-          KTXTransitiveReleaseText(releaseNotesConfig.artifactName.get()),
-          emptyList(),
-        )
-
-    return ktxContent.takeIf { releaseNotesConfig.hasKTX.get() }
+    return unreleased.copy(version = releaseVersion.get())
   }
 
   private fun configure() {
diff --git a/plugins/src/main/java/com/google/firebase/gradle/plugins/ReleaseNotesConfigurationExtension.kt b/plugins/src/main/java/com/google/firebase/gradle/plugins/ReleaseNotesConfigurationExtension.kt
@@ -29,9 +29,6 @@ import org.gradle.api.provider.Property
  * @property enabled Whether to generate release notes for this library. Defaults to true.
  * @property name The variable name mapping for this library, defined on G3.
  * @property versionName The version name mapping for this library, defined on G3.
- * @property hasKTX The library has a sub module with the suffix '-ktx' that releases alongside this
- *   library, and should have the transitive text added to the release notes. Defaults to true. Will
- *   likely be removed when we officially drop KTX libraries.
  * @property artifactName The name of the generation artifact. _Only_ required if your project's
  *   name is different than your generated artifact name. Defaults to the project name.
  * @see MakeReleaseNotesTask
@@ -40,6 +37,5 @@ abstract class ReleaseNotesConfigurationExtension {
   abstract val enabled: Property<Boolean>
   abstract val name: Property<String>
   abstract val versionName: Property<String>
-  abstract val hasKTX: Property<Boolean>
   abstract val artifactName: Property<String>
 }
diff --git a/plugins/src/test/kotlin/com/google/firebase/gradle/plugins/MoveUnreleasedChangesTests.kt b/plugins/src/test/kotlin/com/google/firebase/gradle/plugins/MoveUnreleasedChangesTests.kt
@@ -18,14 +18,10 @@ package com.google.firebase.gradle.plugins
 
 import com.google.firebase.gradle.plugins.ChangeType.FIXED
 import io.kotest.core.spec.style.FunSpec
-import io.kotest.matchers.collections.shouldBeEmpty
 import io.kotest.matchers.collections.shouldContainExactly
 import io.kotest.matchers.collections.shouldHaveAtLeastSize
 import io.kotest.matchers.collections.shouldHaveSize
 import io.kotest.matchers.shouldBe
-import io.kotest.matchers.shouldNot
-import io.kotest.matchers.shouldNotBe
-import io.kotest.matchers.string.beEmpty
 import io.kotest.matchers.string.shouldMatch
 import java.io.File
 import org.gradle.testkit.runner.GradleRunner
@@ -56,22 +52,6 @@ class MoveUnreleasedChangesTests : FunSpec() {
     releasedEntry.ktx shouldBe ktxEntry
   }
 
-  @Test
-  fun `Uses template text on KTX libs with no changes`() {
-    basicChangelog.releases.first().ktx shouldBe null
-
-    val newChangelog = buildWithChangelog(basicChangelog)
-    validateChangelog(basicChangelog, newChangelog)
-
-    val releasedEntry = newChangelog.releases[1]
-
-    releasedEntry.ktx shouldNotBe null
-    releasedEntry.ktx?.let {
-      it.subtext shouldNot beEmpty()
-      it.changes.shouldBeEmpty()
-    }
-  }
-
   @Test
   fun `Handles empty Unreleased sections`() {
     val changelog = basicChangelog.replaceUnreleasedWith { ReleaseEntry.Empty }
diff --git a/plugins/src/test/resources/BasicProject/firebase-storage/CHANGELOG.md b/plugins/src/test/resources/BasicProject/firebase-storage/CHANGELOG.md
@@ -45,14 +45,6 @@ Note: We did some super cool stuff here!
 
 * [removed] some stuff that we didn't really like got removed
 
-## Kotlin
-* [feature] Added
-  [`Query.dataObjects<T>()`](/docs/reference/kotlin/com/google/firebase/firestore/ktx/package-summary#dataObjects)
-  and
-  [`DocumentReference.dataObjects<T>()`](/docs/reference/kotlin/com/google/firebase/firestore/ktx/package-summary#dataObjects_1)
-  Kotlin Flows to listen for realtime updates and convert its values to a
-  specific type.
-
 # 24.5.0
 * [fixed] Fixed stack overflow caused by deeply nested server timestamps.
   (GitHub [#4702](//github.com/firebase/firebase-android-sdk/issues/4702){: .external})
diff --git a/plugins/src/test/resources/MakeReleaseNotes/release-notes.md b/plugins/src/test/resources/MakeReleaseNotes/release-notes.md
@@ -45,12 +45,3 @@ Note: We did some super cool stuff here!
 * {{unchanged}} Idk ig we did some stuff
 
 * {{removed}} some stuff that we didn't really like got removed
-
-#### {{firebase_storage_full}} Kotlin extensions version 24.6.0 {: #storage-ktx_v24-6-0}
-
-* {{feature}} Added
-  [`Query.dataObjects<T>()`](/docs/reference/kotlin/com/google/firebase/firestore/ktx/package-summary#dataObjects)
-  and
-  [`DocumentReference.dataObjects<T>()`](/docs/reference/kotlin/com/google/firebase/firestore/ktx/package-summary#dataObjects_1)
-  Kotlin Flows to listen for realtime updates and convert its values to a
-  specific type.

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,6 @@ firebaseLibrary {`
`23`	`23`	`releaseNotes {`
`24`	`24`	`name.set("{{app_check}} Debug Testing")`
`25`	`25`	`versionName.set("appcheck-debug-testing")`
`26`		`- hasKTX.set(false)`
`27`	`26`	`}`
`28`	`27`	`}`
`29`	`28`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,6 @@ firebaseLibrary {`
`21`	`21`	`releaseNotes {`
`22`	`22`	`name.set("{{app_check}} Debug")`
`23`	`23`	`versionName.set("appcheck-debug")`
`24`		`- hasKTX.set(false)`
`25`	`24`	`}`
`26`	`25`	`}`
`27`	`26`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,6 @@ firebaseLibrary {`
`22`	`22`	`releaseNotes {`
`23`	`23`	`name.set("{{ab_testing}}")`
`24`	`24`	`versionName.set("ab_testing")`
`25`		`- hasKTX.set(false)`
`26`	`25`	`}`
`27`	`26`	`}`
`28`	`27`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,6 @@ firebaseLibrary {`
`30`	`30`	`releaseNotes {`
`31`	`31`	`name.set("{{firebase_ai_logic}}")`
`32`	`32`	`versionName.set("ai")`
`33`		`- hasKTX.set(false)`
`34`	`33`	`}`
`35`	`34`	`}`
`36`	`35`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,6 @@ firebaseLibrary {`
`24`	`24`	`releaseNotes {`
`25`	`25`	`name.set("{{appdistro}}")`
`26`	`26`	`versionName.set("app-distro")`
`27`		`- hasKTX.set(false)`
`28`	`27`	`}`
`29`	`28`	`}`
`30`	`29`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,6 @@ firebaseLibrary {`
`26`	`26`	`releaseNotes {`
`27`	`27`	`name.set("{{crashlytics}} NDK")`
`28`	`28`	`versionName.set("crashlytics-ndk")`
`29`		`- hasKTX.set(false)`
`30`	`29`	`}`
`31`	`30`	`testLab.enabled = true`
`32`	`31`	`publishJavadoc = false`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,6 @@ firebaseLibrary {`
`31`	`31`	`releaseNotes {`
`32`	`32`	`name.set("{{data_connect_short}}")`
`33`	`33`	`versionName.set("data-connect")`
`34`		`- hasKTX.set(false)`
`35`	`34`	`}`
`36`	`35`	`}`
`37`	`36`