diff --git a/README.md b/README.md index 948d6254ce3..e198270d016 100644 --- a/README.md +++ b/README.md @@ -8,18 +8,18 @@ More information about Firebase can be found at https://firebase.google.com. ## Table of contents 1. [Getting Started](#getting-started) -1. [Testing](#testing) +2. [Testing](#testing) 1. [Unit Testing](#unit-testing) - 1. [Integration Testing](#integration-testing) -1. [Proguarding](#proguarding) + 2. [Integration Testing](#integration-testing) +3. [Proguarding](#proguarding) 1. [APIs used via reflection](#APIs-used-via-reflection) - 1. [APIs intended for developer consumption](#APIs-intended-for-developer-consumption) - 1. [APIs intended for other Firebase SDKs](#APIs-intended-for-other-firebase-sdks) -1. [Publishing](#publishing) + 2. [APIs intended for developer consumption](#APIs-intended-for-developer-consumption) + 3. [APIs intended for other Firebase SDKs](#APIs-intended-for-other-firebase-sdks) +4. [Publishing](#publishing) 1. [Dependencies](#dependencies) - 1. [Commands](#commands) -1. [Code Formatting](#code-formatting) -1. [Contributing](#contributing) + 2. [Commands](#commands) +5. [Code Formatting](#code-formatting) +6. [Contributing](#contributing) ## Getting Started diff --git a/agents.md b/agents.md index bd058e68114..14c85aa2d52 100644 --- a/agents.md +++ b/agents.md @@ -28,43 +28,36 @@ This file is useful for understanding the role of each subproject in the reposit To work with this repository, the Android SDK must be installed. Use the `sdkmanager` command-line tool for this purpose. -1. **Install Android SDK Command-Line Tools**: - - - If not already installed, download the command-line tools from the - [Android Studio page](https://developer.android.com/studio#command-line-tools-only). - - Create a directory for the Android SDK, e.g., `android_sdk`. - - Unzip the downloaded package. This will create a `cmdline-tools` directory. Move this - directory to `android_sdk/cmdline-tools/latest`. - - The final structure should be `android_sdk/cmdline-tools/latest/`. - -2. **Install required SDK packages**: - - - Use `sdkmanager` to install the necessary platforms, build tools, and other packages. For - example: - - ```bash - # List all available packages - sdkmanager --list - - # Install platform tools and the SDK for API level 33 - sdkmanager "platform-tools" "platforms;android-33" - - # Accept all licenses - yes | sdkmanager --licenses - ``` - - - Refer to the specific requirements of the project to determine which packages to install. - -3. **Configure for integration tests**: - - - To run integration tests, a `google-services.json` file is required. - - Place this file in the root of the repository. - -4. **Install NDK for specific projects**: - - Some projects, like `firebase-crashlytics-ndk`, require a specific version of the Android NDK. - You can install it using `sdkmanager`. For example, to install NDK version 21.4.7075529, you - would run `sdkmanager "ndk;21.4.7075529"`. Always refer to the project's `README.md` for the - exact version required. +1. **Install Android SDK Command-Line Tools**: + - If not already installed, download the command-line tools from the + [Android Studio page](https://developer.android.com/studio#command-line-tools-only). + - Create a directory for the Android SDK, e.g., `android_sdk`. + - Unzip the downloaded package. This will create a `cmdline-tools` directory. Move this + directory to `android_sdk/cmdline-tools/latest`. + - The final structure should be `android_sdk/cmdline-tools/latest/`. +2. **Install required SDK packages**: + - Use `sdkmanager` to install the necessary platforms, build tools, and other packages. For + example: + + ```bash + # List all available packages + sdkmanager --list + + # Install platform tools and the SDK for API level 33 + sdkmanager "platform-tools" "platforms;android-33" + + # Accept all licenses + yes | sdkmanager --licenses + ``` + - Refer to the specific requirements of the project to determine which packages to install. +3. **Configure for integration tests**: + - To run integration tests, a `google-services.json` file is required. + - Place this file in the root of the repository. +4. **Install NDK for specific projects**: + - Some projects, like `firebase-crashlytics-ndk`, require a specific version of the Android NDK. + You can install it using `sdkmanager`. For example, to install NDK version 21.4.7075529, you + would run `sdkmanager "ndk;21.4.7075529"`. Always refer to the project's `README.md` for the + exact version required. ## Building and Running @@ -182,10 +175,12 @@ started. After you make a change, here's the flow you should follow: - Format the code using `spotless`. It can be run with: + ```bash ./gradlew ::spotlessApply ``` - Run unit tests: + ```bash ./gradlew ::check ``` diff --git a/appcheck/firebase-appcheck-debug-testing/CHANGELOG.md b/appcheck/firebase-appcheck-debug-testing/CHANGELOG.md index d3ff3c5361b..8b757c8e6f2 100644 --- a/appcheck/firebase-appcheck-debug-testing/CHANGELOG.md +++ b/appcheck/firebase-appcheck-debug-testing/CHANGELOG.md @@ -80,3 +80,4 @@ # 16.0.0-beta01 - [feature] Initial beta release of the [app_check] Debug Testing SDK with abuse reduction features. + diff --git a/appcheck/firebase-appcheck-debug/CHANGELOG.md b/appcheck/firebase-appcheck-debug/CHANGELOG.md index b0e1b2b44ec..2733b2809a5 100644 --- a/appcheck/firebase-appcheck-debug/CHANGELOG.md +++ b/appcheck/firebase-appcheck-debug/CHANGELOG.md @@ -85,3 +85,4 @@ # 16.0.0-beta01 - [feature] Initial beta release of the [app_check] Debug SDK with abuse reduction features. + diff --git a/appcheck/firebase-appcheck-interop/CHANGELOG.md b/appcheck/firebase-appcheck-interop/CHANGELOG.md index 79e701b844d..a1ecf841edb 100644 --- a/appcheck/firebase-appcheck-interop/CHANGELOG.md +++ b/appcheck/firebase-appcheck-interop/CHANGELOG.md @@ -1 +1,2 @@ # Unreleased + diff --git a/appcheck/firebase-appcheck-playintegrity/CHANGELOG.md b/appcheck/firebase-appcheck-playintegrity/CHANGELOG.md index 5a7b56788c0..5d25456ab99 100644 --- a/appcheck/firebase-appcheck-playintegrity/CHANGELOG.md +++ b/appcheck/firebase-appcheck-playintegrity/CHANGELOG.md @@ -56,3 +56,4 @@ - [feature] Added support for [Play Integrity](https://developer.android.com/google/play/integrity) as an attestation provider. + diff --git a/appcheck/firebase-appcheck/CHANGELOG.md b/appcheck/firebase-appcheck/CHANGELOG.md index 88d12d6afc3..a7bdb59e185 100644 --- a/appcheck/firebase-appcheck/CHANGELOG.md +++ b/appcheck/firebase-appcheck/CHANGELOG.md @@ -152,3 +152,4 @@ Kotlin extensions library has the following additional updates: # 16.0.0-beta01 - [feature] Initial beta release of the [app_check] SDK with abuse reduction features. + diff --git a/build.gradle.kts b/build.gradle.kts index 022bd0e5d4b..3dccea32af8 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -61,10 +61,10 @@ fun Project.applySpotless() { target("*.gradle.kts") // default target for kotlinGradle ktfmt("0.41").googleStyle() } - format("styling") { + flexmark { target("src/**/*.md", "*.md", "docs/**/*.md") targetExclude("**/third_party/**", "src/test/resources/**", "release_report.md") - prettier().config(mapOf("printWidth" to 100, "proseWrap" to "always")) + flexmark("0.64.8") } } } diff --git a/docs/README.md b/docs/README.md index dfedd7abcf4..1fce5b32f2d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -35,3 +35,4 @@ idiomatic Kotlin code when using Firebase in your app: [android-setup]: https://firebase.google.com/docs/android/setup [main-readme]: https://github.com/firebase/firebase-android-sdk/blob/main/README.md + diff --git a/encoders/README.md b/encoders/README.md index afc897087d2..ee59885ea0b 100644 --- a/encoders/README.md +++ b/encoders/README.md @@ -146,3 +146,4 @@ dependencies { kapt project(":encoders:firebase-encoders-processor") } ``` + diff --git a/encoders/firebase-decoders-json/CHANGELOG.md b/encoders/firebase-decoders-json/CHANGELOG.md index 79e701b844d..a1ecf841edb 100644 --- a/encoders/firebase-decoders-json/CHANGELOG.md +++ b/encoders/firebase-decoders-json/CHANGELOG.md @@ -1 +1,2 @@ # Unreleased + diff --git a/encoders/firebase-encoders-json/CHANGELOG.md b/encoders/firebase-encoders-json/CHANGELOG.md index 79e701b844d..a1ecf841edb 100644 --- a/encoders/firebase-encoders-json/CHANGELOG.md +++ b/encoders/firebase-encoders-json/CHANGELOG.md @@ -1 +1,2 @@ # Unreleased + diff --git a/encoders/firebase-encoders-processor/CHANGELOG.md b/encoders/firebase-encoders-processor/CHANGELOG.md index 79e701b844d..a1ecf841edb 100644 --- a/encoders/firebase-encoders-processor/CHANGELOG.md +++ b/encoders/firebase-encoders-processor/CHANGELOG.md @@ -1 +1,2 @@ # Unreleased + diff --git a/encoders/firebase-encoders-proto/CHANGELOG.md b/encoders/firebase-encoders-proto/CHANGELOG.md index d43e9b27315..2a56f05cb97 100644 --- a/encoders/firebase-encoders-proto/CHANGELOG.md +++ b/encoders/firebase-encoders-proto/CHANGELOG.md @@ -2,3 +2,4 @@ - [changed] Updated protobuf dependency to `3.25.5` to fix [CVE-2024-7254](https://nvd.nist.gov/vuln/detail/CVE-2024-7254). + diff --git a/encoders/firebase-encoders-reflective/CHANGELOG.md b/encoders/firebase-encoders-reflective/CHANGELOG.md index 79e701b844d..a1ecf841edb 100644 --- a/encoders/firebase-encoders-reflective/CHANGELOG.md +++ b/encoders/firebase-encoders-reflective/CHANGELOG.md @@ -1 +1,2 @@ # Unreleased + diff --git a/encoders/firebase-encoders/CHANGELOG.md b/encoders/firebase-encoders/CHANGELOG.md index 79e701b844d..a1ecf841edb 100644 --- a/encoders/firebase-encoders/CHANGELOG.md +++ b/encoders/firebase-encoders/CHANGELOG.md @@ -1 +1,2 @@ # Unreleased + diff --git a/encoders/protoc-gen-firebase-encoders/CHANGELOG.md b/encoders/protoc-gen-firebase-encoders/CHANGELOG.md index 79e701b844d..a1ecf841edb 100644 --- a/encoders/protoc-gen-firebase-encoders/CHANGELOG.md +++ b/encoders/protoc-gen-firebase-encoders/CHANGELOG.md @@ -1 +1,2 @@ # Unreleased + diff --git a/firebase-abt/CHANGELOG.md b/firebase-abt/CHANGELOG.md index 5d6730988ed..37ecf139a20 100644 --- a/firebase-abt/CHANGELOG.md +++ b/firebase-abt/CHANGELOG.md @@ -62,3 +62,4 @@ # 17.1.0 - [changed] Updated API to support the latest [remote_config] update. + diff --git a/firebase-annotations/CHANGELOG.md b/firebase-annotations/CHANGELOG.md index b716a3fd418..b0ed2d3803b 100644 --- a/firebase-annotations/CHANGELOG.md +++ b/firebase-annotations/CHANGELOG.md @@ -1,3 +1,4 @@ # Unreleased - [changed] Hid Executors from public API, as they are intended to be internal anyhow. + diff --git a/firebase-appdistribution-api/CHANGELOG.md b/firebase-appdistribution-api/CHANGELOG.md index 6465260ea8d..ff86a915bc7 100644 --- a/firebase-appdistribution-api/CHANGELOG.md +++ b/firebase-appdistribution-api/CHANGELOG.md @@ -135,7 +135,6 @@ library. The Kotlin extensions library has no additional updates. # 16.0.0-beta03 - [feature] The [appdistro] SDK has been split into two libraries: - - `firebase-appdistribution-api` - The API-only library
This new API-only library is functional only when the full [appdistro] SDK implementation (`firebase-appdistribution`) is present. `firebase-appdistribution-api` can be included in all diff --git a/firebase-appdistribution/CHANGELOG.md b/firebase-appdistribution/CHANGELOG.md index fa9f7c8f02d..624e1c2faa7 100644 --- a/firebase-appdistribution/CHANGELOG.md +++ b/firebase-appdistribution/CHANGELOG.md @@ -56,7 +56,6 @@ # 16.0.0-beta03 - [feature] The [appdistro] SDK has been split into two libraries: - - `firebase-appdistribution-api` - The API-only library
This new API-only library is functional only when the full [appdistro] SDK implementation (`firebase-appdistribution`) is present. `firebase-appdistribution-api` can be included in all diff --git a/firebase-common/README.md b/firebase-common/README.md index 3b3cea4b37a..ec786f3a856 100644 --- a/firebase-common/README.md +++ b/firebase-common/README.md @@ -16,3 +16,4 @@ Integration tests are run by ``` $ ./gradlew :firebase-common:connectedCheck ``` + diff --git a/firebase-components/CHANGELOG.md b/firebase-components/CHANGELOG.md index 73f17b8e426..58005a77fe1 100644 --- a/firebase-components/CHANGELOG.md +++ b/firebase-components/CHANGELOG.md @@ -18,3 +18,4 @@ Kotlin extensions library has no additional updates. - [changed] Internal changes to ensure only one interface is provided for kotlinx.coroutines.CoroutineDispatcher interfaces when both firebase-common and firebase-common-ktx provide them. + diff --git a/firebase-components/firebase-dynamic-module-support/CHANGELOG.md b/firebase-components/firebase-dynamic-module-support/CHANGELOG.md index e18540f051a..aa4e0d27a23 100644 --- a/firebase-components/firebase-dynamic-module-support/CHANGELOG.md +++ b/firebase-components/firebase-dynamic-module-support/CHANGELOG.md @@ -7,3 +7,4 @@ # 16.0.0-beta03 - [changed] Updated dependency of play-services-basement to its latest version (v18.1.0). + diff --git a/firebase-config-interop/CHANGELOG.md b/firebase-config-interop/CHANGELOG.md index 54976cbf39d..85616227716 100644 --- a/firebase-config-interop/CHANGELOG.md +++ b/firebase-config-interop/CHANGELOG.md @@ -5,3 +5,4 @@ # 16.0.0 - [feature] Initial release. + diff --git a/firebase-config/CHANGELOG.md b/firebase-config/CHANGELOG.md index fca96b9131f..79122fb5556 100644 --- a/firebase-config/CHANGELOG.md +++ b/firebase-config/CHANGELOG.md @@ -183,7 +183,7 @@ Kotlin extensions library has no additional updates. - [fixed] Fixed a bug that caused HTTP errors in some locales. For more information, see GitHub Issue #3757 + class="external">GitHub Issue #3757 ## Kotlin @@ -535,3 +535,4 @@ Kotlin extensions library has no additional updates. # 16.1.0 - [fixed] Bug fixes and internal improvements to support Firebase Performance Monitoring features. + diff --git a/firebase-crashlytics-ndk/CHANGELOG.md b/firebase-crashlytics-ndk/CHANGELOG.md index 61a2be75dfc..e826066f5d7 100644 --- a/firebase-crashlytics-ndk/CHANGELOG.md +++ b/firebase-crashlytics-ndk/CHANGELOG.md @@ -319,3 +319,4 @@ the new SDK. [crashlytics] servers. See the [[crashlytics] Gradle plugin documentation](/docs/crashlytics/ndk-reports-new-sdk) for more information. + diff --git a/firebase-crashlytics/CHANGELOG.md b/firebase-crashlytics/CHANGELOG.md index b4c799dcaf3..0155b76879a 100644 --- a/firebase-crashlytics/CHANGELOG.md +++ b/firebase-crashlytics/CHANGELOG.md @@ -696,3 +696,4 @@ name change. The following release notes describe changes in the new SDK. app from Fabric, remove the Fabric API key from your `AndroidManifest.xml` file. - [removed] The `fabric.properties` and `crashlytics.properties` files are no longer supported. Remove them from your app. + diff --git a/firebase-database-collection/CHANGELOG.md b/firebase-database-collection/CHANGELOG.md index 79e701b844d..a1ecf841edb 100644 --- a/firebase-database-collection/CHANGELOG.md +++ b/firebase-database-collection/CHANGELOG.md @@ -1 +1,2 @@ # Unreleased + diff --git a/firebase-database/CHANGELOG.md b/firebase-database/CHANGELOG.md index 0fc6708714b..616f9074e3b 100644 --- a/firebase-database/CHANGELOG.md +++ b/firebase-database/CHANGELOG.md @@ -312,3 +312,4 @@ Kotlin extensions library has no additional updates. # 16.0.1 - [changed] Added `Nullability` annotations to all public API classes/methods. + diff --git a/firebase-dataconnect/CHANGELOG.md b/firebase-dataconnect/CHANGELOG.md index 412b5c2d4fa..196af3579ad 100644 --- a/firebase-dataconnect/CHANGELOG.md +++ b/firebase-dataconnect/CHANGELOG.md @@ -117,3 +117,4 @@ ([#6299](https://github.com/firebase/firebase-android-sdk/pull/6299)) - [changed] Added `equals` and `hashCode` methods to `GeneratedConnector`. ([#6177](https://github.com/firebase/firebase-android-sdk/pull/6177)) + diff --git a/firebase-dataconnect/README.md b/firebase-dataconnect/README.md index 130b31ea113..e230b169772 100644 --- a/firebase-dataconnect/README.md +++ b/firebase-dataconnect/README.md @@ -40,14 +40,17 @@ The integration tests require that the Firebase Data Connect emulator is running is default when running it via the Firebase CLI. - [Install the Firebase CLI](https://firebase.google.com/docs/cli/). + ``` npm install -g firebase-tools ``` - [Install the Firebase Data Connect emulator](https://firebase.google.com/docs/FIX_URL/security/test-rules-emulator#install_the_emulator). + ``` firebase setup:emulators:dataconnect ``` - Run the emulator + ``` firebase emulators:start --only dataconnect ``` @@ -110,3 +113,4 @@ changes with the command: ``` $ git checkout .idea/runConfigurations ``` + diff --git a/firebase-datatransport/CHANGELOG.md b/firebase-datatransport/CHANGELOG.md index dab5b20aacb..1b407ee1e15 100644 --- a/firebase-datatransport/CHANGELOG.md +++ b/firebase-datatransport/CHANGELOG.md @@ -15,3 +15,4 @@ # 18.2.0 - [feature] Expose the transport factory as a qualified dependency based on the endpoint connected. + diff --git a/firebase-firestore/CHANGELOG.md b/firebase-firestore/CHANGELOG.md index 5418475a1a5..dc7a04091b4 100644 --- a/firebase-firestore/CHANGELOG.md +++ b/firebase-firestore/CHANGELOG.md @@ -11,7 +11,6 @@ [#7388](//github.com/firebase/firebase-android-sdk/pull/7388) - [changed] Improve query performance by using an unsorted HashMap instead of a sorted TreeMap. [#7389](//github.com/firebase/firebase-android-sdk/pull/7389) - * [changed] Add `java.time.Instant` support to `DocumentSnapshot.toObject()`, `DocumentReference.set()`, `DocumentReference.update()`, and similar. [#6235](//github.com/firebase/firebase-android-sdk/pull/6235) @@ -1010,3 +1009,4 @@ Kotlin extensions library has no additional updates. or [`FieldValue.serverTimestamp()`]() values. + diff --git a/firebase-firestore/README.md b/firebase-firestore/README.md index 65f2c8da877..f6d560622d1 100644 --- a/firebase-firestore/README.md +++ b/firebase-firestore/README.md @@ -47,14 +47,17 @@ The integration tests require that the Firestore emulator is running on port 808 when running it via CLI. - [Install the Firebase CLI](https://firebase.google.com/docs/cli/). + ``` npm install -g firebase-tools ``` - [Install the Firestore emulator](https://firebase.google.com/docs/firestore/security/test-rules-emulator#install_the_emulator). + ``` firebase setup:emulators:firestore ``` - Run the emulator + ``` firebase emulators:start --only firestore ``` @@ -200,16 +203,17 @@ android.util.Log.i("FirestoreVersion", com.google.firebase.firestore.BuildConfig If your changes require building other modules in this repository (like `firebase-common`), you must build and publish them locally as well. -1. In the dependency's directory (e.g., `firebase-common/`), edit `gradle.properties` to set a - unique version. -2. Publish the dependency to Maven Local: - ```bash - ./gradlew :firebase-common:publishToMavenLocal - ``` -3. In `firebase-firestore/firebase-firestore.gradle`, ensure the dependency is a project - dependency. For example, change `api(libs.firebase.common)` to - `api(project(":firebase-common"))`. -4. Build and publish the `firebase-firestore` artifact as described in step 2. +1. In the dependency's directory (e.g., `firebase-common/`), edit `gradle.properties` to set a + unique version. +2. Publish the dependency to Maven Local: + + ```bash + ./gradlew :firebase-common:publishToMavenLocal + ``` +3. In `firebase-firestore/firebase-firestore.gradle`, ensure the dependency is a project + dependency. For example, change `api(libs.firebase.common)` to + `api(project(":firebase-common"))`. +4. Build and publish the `firebase-firestore` artifact as described in step 2. ## Misc @@ -220,3 +224,4 @@ changes with the command: ``` $ git checkout .idea/runConfigurations ``` + diff --git a/firebase-functions/CHANGELOG.md b/firebase-functions/CHANGELOG.md index ba8c41c1310..2c7f0d70fd9 100644 --- a/firebase-functions/CHANGELOG.md +++ b/firebase-functions/CHANGELOG.md @@ -263,3 +263,4 @@ Kotlin extensions library has no additional updates. the default "us-central1". - [feature] New `useFunctionsEmulator` method allows testing against a local instance of the [Cloud Functions Emulator](https://firebase.google.com/docs/functions/local-emulator). + diff --git a/firebase-functions/src/androidTest/backend/README.md b/firebase-functions/src/androidTest/backend/README.md index 4462eb5efdc..f713d431c81 100644 --- a/firebase-functions/src/androidTest/backend/README.md +++ b/firebase-functions/src/androidTest/backend/README.md @@ -13,3 +13,4 @@ firebase use $PROJECT_ID echo $(cd functions && npm install) firebase deploy --only functions ``` + diff --git a/firebase-inappmessaging-display/CHANGELOG.md b/firebase-inappmessaging-display/CHANGELOG.md index 875a76d797d..64f752ca132 100644 --- a/firebase-inappmessaging-display/CHANGELOG.md +++ b/firebase-inappmessaging-display/CHANGELOG.md @@ -376,3 +376,4 @@ library. The Kotlin extensions library has no additional updates. - [feature] The initial public beta release of the Firebase In-App Messaging Display SDK for Android is now available. To learn more, see the [Firebase In-App Messaging documentation](/docs/in-app-messaging). + diff --git a/firebase-inappmessaging/CHANGELOG.md b/firebase-inappmessaging/CHANGELOG.md index c69fb6d8231..fdb982caf68 100644 --- a/firebase-inappmessaging/CHANGELOG.md +++ b/firebase-inappmessaging/CHANGELOG.md @@ -374,3 +374,4 @@ The Kotlin extensions library has no additional updates. - [feature] The initial public beta release of the Firebase In-App Messaging SDK for Android is now available. To learn more, see the [Firebase In-App Messaging documentation](/docs/in-app-messaging). + diff --git a/firebase-installations-interop/CHANGELOG.md b/firebase-installations-interop/CHANGELOG.md index 40ef46d376e..2fd5aa0766c 100644 --- a/firebase-installations-interop/CHANGELOG.md +++ b/firebase-installations-interop/CHANGELOG.md @@ -1,3 +1,4 @@ # Unreleased - [changed] Release to align with ktx changes + diff --git a/firebase-installations/API_KEY_RESTRICTIONS.md b/firebase-installations/API_KEY_RESTRICTIONS.md index 34f5cc6d498..513b77a3152 100644 --- a/firebase-installations/API_KEY_RESTRICTIONS.md +++ b/firebase-installations/API_KEY_RESTRICTIONS.md @@ -26,13 +26,13 @@ key(s) used in your application(s) are whitelisted for the Firebase Installation 1. **Open** the [Google Cloud Platform Console](https://console.cloud.google.com/apis/credentials?folder). -1. **Choose** the project you use for your application(s). -1. **Open** `APIs & Services` and **select** `Credentials`. -1. **Click** `Edit API Key` (pencil icon) for the API key in question. -1. **Scroll down** to the `API restrictions` section. -1. From the dropdown menu, **add** the `Firebase Installations API` to the list of permitted APIs, +2. **Choose** the project you use for your application(s). +3. **Open** `APIs & Services` and **select** `Credentials`. +4. **Click** `Edit API Key` (pencil icon) for the API key in question. +5. **Scroll down** to the `API restrictions` section. +6. From the dropdown menu, **add** the `Firebase Installations API` to the list of permitted APIs, and click `Save`. -1. If the radio button shows `Don't restrict key`, you may be looking at the wrong API key. \ +7. If the radio button shows `Don't restrict key`, you may be looking at the wrong API key. \ You can check which API key is used for the Firebase Installations API by looking at the [service usage page for your project](https://console.cloud.google.com/apis/api/firebaseinstallations.googleapis.com/credentials). **Note**: **Verify** your fix by checking if you can see successful `200` requests increasing on the diff --git a/firebase-installations/CHANGELOG.md b/firebase-installations/CHANGELOG.md index 3427fdbc9ca..910ff0c0ca9 100644 --- a/firebase-installations/CHANGELOG.md +++ b/firebase-installations/CHANGELOG.md @@ -53,3 +53,4 @@ The Kotlin extensions library has no additional updates. - [changed] Internal changes to ensure functionality alignment with other SDK releases. For more details, refer to the [Firebase Instance ID v21.1.0 release notes](/support/release-notes/android#iid_v21-1-0). + diff --git a/firebase-installations/REQUIRED_FIREBASE_OPTIONS_ANDROID.md b/firebase-installations/REQUIRED_FIREBASE_OPTIONS_ANDROID.md index 084ceb39f37..7c5d217f62a 100644 --- a/firebase-installations/REQUIRED_FIREBASE_OPTIONS_ANDROID.md +++ b/firebase-installations/REQUIRED_FIREBASE_OPTIONS_ANDROID.md @@ -63,7 +63,7 @@ soon as possible:** [Download your `google-services.json` config file](https://support.google.com/firebase/answer/7015592) from the Firebase console to find your API key, Project ID, and Application ID, then update these values in the `FirebaseOptions` object in your app. -1. Release a new version of your app to the Play Store. +2. Release a new version of your app to the Play Store. ## FCM Server keys diff --git a/firebase-messaging-directboot/CHANGELOG.md b/firebase-messaging-directboot/CHANGELOG.md index baf25a78f6a..6d372fa6af2 100644 --- a/firebase-messaging-directboot/CHANGELOG.md +++ b/firebase-messaging-directboot/CHANGELOG.md @@ -170,3 +170,4 @@ issue was released on July 08, 2020 (see messages in Direct Boot mode. See [Receive FCM messages in direct boot mode](/docs/cloud-messaging/android/receive#receive_fcm_messages_in_direct_boot_mode) for more information. + diff --git a/firebase-messaging/CHANGELOG.md b/firebase-messaging/CHANGELOG.md index 57eb532a2c4..e80016e2ff3 100644 --- a/firebase-messaging/CHANGELOG.md +++ b/firebase-messaging/CHANGELOG.md @@ -432,11 +432,10 @@ and should not be used. A fix for these issues was released on - [changed] [messaging_longer] now transitively depends on the [installations_sdk]. After updating to the latest dependency versions, make sure that push notifications still work as expected. Also, be aware of the following: - - The [messaging] registration tokens of installed instances of your apps might change once after updating dependencies to their latest versions. To learn if your apps are affected, review the [firebase_installations] documentation. Also, make sure to + class="external">[firebase_installations] documentation. Also, make sure to monitor [messaging] registration token generation using the #onNewToken implementation. @@ -525,3 +524,4 @@ and should not be used. A fix for these issues was released on [`FirebaseMessaging`](/docs/reference/android/com/google/firebase/messaging/FirebaseMessaging) now return a [`Task`](/docs/reference/android/com/google/android/gms/tasks/Task) that can be used to see when the request has completed. + diff --git a/firebase-ml-modeldownloader/CHANGELOG.md b/firebase-ml-modeldownloader/CHANGELOG.md index 6f2a4714fa2..ad0105e6811 100644 --- a/firebase-ml-modeldownloader/CHANGELOG.md +++ b/firebase-ml-modeldownloader/CHANGELOG.md @@ -200,3 +200,4 @@ custom hosted models without the interpreter API, which is now provided directly - [feature] Added custom hosted model download and on-device management capabilities. - [feature] Added ability to get the model download ID, which allows progress tracking of file downloads. + diff --git a/firebase-perf/CHANGELOG.md b/firebase-perf/CHANGELOG.md index 72ca50fcbe3..e8ef76717c1 100644 --- a/firebase-perf/CHANGELOG.md +++ b/firebase-perf/CHANGELOG.md @@ -455,3 +455,4 @@ Kotlin extensions library has no additional updates. - [fixed] Fixed a `SecurityException` crash on certain devices that do not have Google Play Services on them. + diff --git a/firebase-perf/dev-app/README.md b/firebase-perf/dev-app/README.md index efec896ce2b..f026977aa9b 100644 --- a/firebase-perf/dev-app/README.md +++ b/firebase-perf/dev-app/README.md @@ -32,7 +32,7 @@ firebase-android-sdk$ ./gradlew :clean :firebase-perf:dev-app:build ``` > **Note:** Builds with latest public version of `firebase-perf` SDK. - +> > **Tip:** The above command will build all the configured variants which may slow down the build. > To fasten local development replace `build` with `assembleRelease` task. To view the complete list > of tasks available run `./gradlew :clean :firebase-perf:dev-app:tasks --all`. @@ -90,7 +90,7 @@ scenarios. but the performance events are sent to a different project with which apps are configured with (see `copyRootGoogleServices` task). -1. **Local run**: When running locally both the tests and the events will happen on the same locally +2. **Local run**: When running locally both the tests and the events will happen on the same locally integrated Firebase project. ## Logs @@ -120,3 +120,4 @@ And go to the following locations to check for app artifact size: - Debug: `firebase-perf/dev-app/build/outputs/apk/debug/dev-app-debug.apk` - Release: `firebase-perf/dev-app/build/outputs/apk/release/dev-app-release.apk` - Aggressive: `firebase-perf/dev-app/build/outputs/apk/aggressive/dev-app-aggressive.apk` + diff --git a/firebase-perf/e2e-app/README.md b/firebase-perf/e2e-app/README.md index 3092726076c..d190bab06d9 100644 --- a/firebase-perf/e2e-app/README.md +++ b/firebase-perf/e2e-app/README.md @@ -32,7 +32,7 @@ firebase-android-sdk$ ./gradlew :clean :firebase-perf:e2e-app:build ``` > **Note:** Builds with latest public version of `firebase-perf` SDK. - +> > **Tip:** The above command will build all the configured variants which may slow down the build. > To fasten local development replace `build` with `assembleRelease` task. To view the complete list > of all available tasks run `./gradlew :clean :firebase-perf:e2e-app:tasks --all`. @@ -83,7 +83,7 @@ scenarios. but the performance events are sent to a different project with which apps are configured with (see `copyRootGoogleServices` task) and the Prow Configuration in tg/831643). -1. **Local run**: When running locally both the tests and the events will happen on the same locally +2. **Local run**: When running locally both the tests and the events will happen on the same locally integrated Firebase project. ## Logs diff --git a/firebase-sessions/CHANGELOG.md b/firebase-sessions/CHANGELOG.md index 46db93d2d3e..e7825b2dadf 100644 --- a/firebase-sessions/CHANGELOG.md +++ b/firebase-sessions/CHANGELOG.md @@ -85,3 +85,4 @@ # 1.0.0 - [feature] Initial Firebase sessions library. + diff --git a/firebase-sessions/benchmark/README.md b/firebase-sessions/benchmark/README.md index 13a9941c665..d802ed3fea8 100644 --- a/firebase-sessions/benchmark/README.md +++ b/firebase-sessions/benchmark/README.md @@ -3,3 +3,4 @@ ## Setup ## Run + diff --git a/firebase-storage/CHANGELOG.md b/firebase-storage/CHANGELOG.md index 46dc4c60c01..c1bc899bae8 100644 --- a/firebase-storage/CHANGELOG.md +++ b/firebase-storage/CHANGELOG.md @@ -232,3 +232,4 @@ Kotlin extensions library has no additional updates. - [changed] Removed the deprecated `StorageMetadata.getDownloadUrl()` and `UploadTask.TaskSnapshot.getDownloadUrl()` methods. To get a current download URL, use [`StorageReference.getDownloadUr()`](). + diff --git a/transport/transport-api/CHANGELOG.md b/transport/transport-api/CHANGELOG.md index a6ed0cb6d3f..4d93ebb3f3f 100644 --- a/transport/transport-api/CHANGELOG.md +++ b/transport/transport-api/CHANGELOG.md @@ -17,3 +17,4 @@ extensions library has no additional updates. # 3.1.0 - [feature] Added new APIs to support passing a product id when logging an event. + diff --git a/transport/transport-backend-cct/CHANGELOG.md b/transport/transport-backend-cct/CHANGELOG.md index 56f6c2bb0c4..d556fcc7127 100644 --- a/transport/transport-backend-cct/CHANGELOG.md +++ b/transport/transport-backend-cct/CHANGELOG.md @@ -17,3 +17,4 @@ Kotlin extensions library has no additional updates. # 3.2.0 - [feature] Added support for product id. + diff --git a/transport/transport-runtime-testing/CHANGELOG.md b/transport/transport-runtime-testing/CHANGELOG.md index 79e701b844d..a1ecf841edb 100644 --- a/transport/transport-runtime-testing/CHANGELOG.md +++ b/transport/transport-runtime-testing/CHANGELOG.md @@ -1 +1,2 @@ # Unreleased + diff --git a/transport/transport-runtime/CHANGELOG.md b/transport/transport-runtime/CHANGELOG.md index 50fc1e77489..05ca75f443c 100644 --- a/transport/transport-runtime/CHANGELOG.md +++ b/transport/transport-runtime/CHANGELOG.md @@ -18,3 +18,4 @@ Kotlin extensions library has no additional updates. - [unchanged] Updated internal Dagger dependency. - [feature] Added support for product id. +