add common release notes (#5370)

Author: VinayGuthal

firebase-common/CHANGELOG.md

@@ -1,4 +1,16 @@
 # Unreleased
+* [changed] Added Kotlin extensions (KTX) APIs from `com.google.firebase:firebase-common-ktx` 
+to `com.google.firebase:firebase-common` under the `com.google.firebase` package. 
+For details, see the
+[FAQ about this initiative](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
+
+## Kotlin
+* [deprecated] All the APIs from `com.google.firebase:firebase-common-ktx` have been added to
+`com.google.firebase:firebase-common` under the `com.google.firebase package`, and all the 
+Kotlin extensions (KTX) APIs in `com.google.firebase:firebase-common-ktx` are now deprecated.
+As early as April 2024, we'll no longer release KTX modules. For details, see the 
+FAQ about this initiative.
+[FAQ about this initiative](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
 
 # 20.3.3
 * [fixed] Addressed issue with C++ being absent in user agent.

firebase-common/src/main/java/com/google/firebase/ktx/Firebase.kt

@@ -33,16 +33,28 @@ import kotlinx.coroutines.asCoroutineDispatcher
  * Single access point to all firebase SDKs from Kotlin.
  *
  * <p>Acts as a target for extension methods provided by sdks.
+ * @deprecated **Deprecation Notice:** The Kotlin extensions (KTX) APIs have been added to their
+ * respective main modules, and the Kotlin extension (KTX) APIs in
+ * `com.google.firebase.firebase-common-ktx` are now deprecated. As early as April 2024, we'll no
+ * longer release KTX modules. For details, see the
+ * [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules)
  */
 @Deprecated(
-  "Use `com.google.firebase.Firebase` from the main module instead. The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in `com.google.firebase:firebase-common-ktx` are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules){:.external}",
+  "Use `com.google.firebase.Firebase` from the main module instead.",
   ReplaceWith(expression = "Firebase", imports = ["com.google.firebase.Firebase"])
 )
 object Firebase
 
-/** Returns the default firebase app instance. */
+/**
+ * Returns the default firebase app instance.
+ * @deprecated **Deprecation Notice:** The Kotlin extensions (KTX) APIs have been added to their
+ * respective main modules, and the Kotlin extension (KTX) APIs in
+ * `com.google.firebase.firebase-common-ktx` are now deprecated. As early as April 2024, we'll no
+ * longer release KTX modules. For details, see the
+ * [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules),
+ */
 @Deprecated(
-  "Use `com.google.firebase.Firebase.app` from the main module instead. The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in `com.google.firebase:firebase-common-ktx` are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules){:.external}",
+  "Use `com.google.firebase.Firebase.app` from the main module instead.",
   ReplaceWith(
     expression = "com.google.firebase.Firebase.app",
     imports = ["com.google.firebase.Firebase", "com.google.firebase.app"],
@@ -51,29 +63,50 @@ object Firebase
 val Firebase.app: FirebaseApp
   get() = FirebaseApp.getInstance()
 
-/** Returns a named firebase app instance. */
+/**
+ * Returns a named firebase app instance.
+ * @deprecated **Deprecation Notice:** The Kotlin extensions (KTX) APIs have been added to their
+ * respective main modules, and the Kotlin extension (KTX) APIs in
+ * `com.google.firebase.firebase-common-ktx` are now deprecated. As early as April 2024, we'll no
+ * longer release KTX modules. For details, see the
+ * [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules),
+ */
 @Deprecated(
-  "Use `com.google.firebase.Firebase.app(name)` from the main module instead. The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in `com.google.firebase:firebase-common-ktx` are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules){:.external}",
+  "Use `com.google.firebase.Firebase.app(name)` from the main module instead.",
   ReplaceWith(
     expression = "com.google.firebase.Firebase.app(name)",
     imports = ["com.google.firebase.Firebase", "com.google.firebase.app"]
   )
 )
 fun Firebase.app(name: String): FirebaseApp = FirebaseApp.getInstance(name)
 
-/** Initializes and returns a FirebaseApp. */
+/**
+ * Initializes and returns a FirebaseApp.
+ * @deprecated **Deprecation Notice:** The Kotlin extensions (KTX) APIs have been added to their
+ * respective main modules, and the Kotlin extension (KTX) APIs in
+ * `com.google.firebase.firebase-common-ktx` are now deprecated. As early as April 2024, we'll no
+ * longer release KTX modules. For details, see the
+ * [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules),
+ */
 @Deprecated(
-  "Use `com.google.firebase.Firebase.initialize(context)` from the main module instead. The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in `com.google.firebase:firebase-common-ktx` are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules){:.external}",
+  "Use `com.google.firebase.Firebase.initialize(context)` from the main module instead.",
   ReplaceWith(
     expression = "com.google.firebase.Firebase.initialize(context)",
     imports = ["com.google.firebase.Firebase", "com.google.firebase.initialize"]
   )
 )
 fun Firebase.initialize(context: Context): FirebaseApp? = FirebaseApp.initializeApp(context)
 
-/** Initializes and returns a FirebaseApp. */
+/**
+ * Initializes and returns a FirebaseApp.
+ * @deprecated **Deprecation Notice:** The Kotlin extensions (KTX) APIs have been added to their
+ * respective main modules, and the Kotlin extension (KTX) APIs in
+ * `com.google.firebase.firebase-common-ktx` are now deprecated. As early as April 2024, we'll no
+ * longer release KTX modules. For details, see the
+ * [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules),
+ */
 @Deprecated(
-  "Use `com.google.firebase.Firebase.initialize(context, options)` from the main module instead. The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in `com.google.firebase:firebase-common-ktx` are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules){:.external}",
+  "Use `com.google.firebase.Firebase.initialize(context, options)` from the main module instead.",
   ReplaceWith(
     expression = "com.google.firebase.Firebase.initialize(context, options)",
     imports = ["com.google.firebase.Firebase", "com.google.firebase.initialize"]
@@ -82,9 +115,16 @@ fun Firebase.initialize(context: Context): FirebaseApp? = FirebaseApp.initialize
 fun Firebase.initialize(context: Context, options: FirebaseOptions): FirebaseApp =
   FirebaseApp.initializeApp(context, options)
 
-/** Initializes and returns a FirebaseApp. */
+/**
+ * Initializes and returns a FirebaseApp.
+ * @deprecated **Deprecation Notice:** The Kotlin extensions (KTX) APIs have been added to their
+ * respective main modules, and the Kotlin extension (KTX) APIs in
+ * `com.google.firebase.firebase-common-ktx` are now deprecated. As early as April 2024, we'll no
+ * longer release KTX modules. For details, see the
+ * [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules),
+ */
 @Deprecated(
-  "Use `com.google.firebase.Firebase.initialize(context, options, name)` from the main module instead. The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in `com.google.firebase:firebase-common-ktx` are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules){:.external}",
+  "Use `com.google.firebase.Firebase.initialize(context, options, name)` from the main module instead.",
   ReplaceWith(
     expression = "com.google.firebase.Firebase.initialize(context, options, name)",
     imports = ["com.google.firebase.Firebase", "com.google.firebase.initialize"]
@@ -93,9 +133,16 @@ fun Firebase.initialize(context: Context, options: FirebaseOptions): FirebaseApp
 fun Firebase.initialize(context: Context, options: FirebaseOptions, name: String): FirebaseApp =
   FirebaseApp.initializeApp(context, options, name)
 
-/** Returns options of default FirebaseApp */
+/**
+ * Returns options of default FirebaseApp
+ * @deprecated **Deprecation Notice:** The Kotlin extensions (KTX) APIs have been added to their
+ * respective main modules, and the Kotlin extension (KTX) APIs in
+ * `com.google.firebase.firebase-common-ktx` are now deprecated. As early as April 2024, we'll no
+ * longer release KTX modules. For details, see the
+ * [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules),
+ */
 @Deprecated(
-  "Use `com.google.firebase.Firebase.options` from the main module instead. The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in `com.google.firebase:firebase-common-ktx` are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules){:.external}",
+  "Use `com.google.firebase.Firebase.options` from the main module instead.",
   ReplaceWith(
     expression = "com.google.firebase.Firebase.options",
     imports = ["com.google.firebase.Firebase", "com.google.firebase.options"]
@@ -106,7 +153,7 @@ val Firebase.options: FirebaseOptions
 
 /** @suppress */
 @Deprecated(
-  "Use `com.google.firebase.FirebaseCommonKtxRegistrar` from the main module instead. The Kotlin extensions (KTX) APIs have been added to their respective main modules, and the Kotlin extension (KTX) APIs in `com.google.firebase:firebase-common-ktx` are now deprecated. As early as April 2024, we'll no longer release KTX modules. For details, see the [FAQ about this initiative.](https://firebase.google.com/docs/android/ktx-apis-to-main-modules){:.external}",
+  "Use `com.google.firebase.FirebaseCommonKtxRegistrar` from the main module instead.",
   ReplaceWith(
     expression = "FirebaseCommonKtxRegistrar",
     imports = ["com.google.firebase.Firebase", "com.google.firebase.FirebaseCommonKtxRegistrar"]