Skip to content

[Firestore] Fix README.md format #7405

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
merged 1 commit into from
Sep 23, 2025
Merged

[Firestore] Fix README.md format #7405

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 19 additions & 17 deletions firebase-firestore/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,21 +126,23 @@ Studio.

## Using a custom build in your application

To build `firebase-firestore` from source and use the resulting artifact in your
Android application, follow these steps.
To build `firebase-firestore` from source and use the resulting artifact in your Android
application, follow these steps.

### 1. Set a custom version

In `firebase-firestore/gradle.properties`, change the `version` to a unique
value. Appending a suffix makes it easy to identify your custom build.
In `firebase-firestore/gradle.properties`, change the `version` to a unique value. Appending a
suffix makes it easy to identify your custom build.

For example, change:

```
version=26.0.2
latestReleasedVersion=26.0.1
```

To:

```
version=99.99.99-MyFix1
latestReleasedVersion=26.0.1
Expand All @@ -149,15 +151,15 @@ latestReleasedVersion=26.0.1
### 2. Build the artifact

Build and publish the artifact to your local Maven repository:

```bash
./gradlew :firebase-firestore:publishToMavenLocal
```

### 3. Update your app's repositories

In your application's `settings.gradle` or `settings.gradle.kts` file, add
`mavenLocal()` to the `repositories` block within
`dependencyResolutionManagement`.
In your application's `settings.gradle` or `settings.gradle.kts` file, add `mavenLocal()` to the
`repositories` block within `dependencyResolutionManagement`.

```kotlin
dependencyResolutionManagement {
Expand All @@ -172,8 +174,8 @@ dependencyResolutionManagement {

### 4. Update your app's dependencies

In your application's `build.gradle` or `build.gradle.kts` file, update the
`firebase-firestore` dependency to use the custom version you set in step 1.
In your application's `build.gradle` or `build.gradle.kts` file, update the `firebase-firestore`
dependency to use the custom version you set in step 1.

```kotlin
dependencies {
Expand All @@ -186,26 +188,26 @@ dependencies {

### Optional: Verify the version at runtime

To confirm that your application is using the custom artifact, you can log its
version. Add the following code to your application:
To confirm that your application is using the custom artifact, you can log its version. Add the
following code to your application:

```kotlin
android.util.Log.i("FirestoreVersion", com.google.firebase.firestore.BuildConfig.VERSION_NAME)
```

### Building with local module dependencies

If your changes require building other modules in this repository (like
`firebase-common`), you must build and publish them locally as well.
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.
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
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.

Expand Down
Loading