Skip to content

Commit a7027d9

Browse files
authored
Merge branch 'main' into mrober/sessionsE2e
2 parents ba144e9 + fbdd4e7 commit a7027d9

File tree

1 file changed

+7
-67
lines changed

1 file changed

+7
-67
lines changed

firebase-perf/README.md

Lines changed: 7 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -82,79 +82,20 @@ firebase-android-sdk$ ./gradlew :firebase-perf:deviceCheck
8282

8383
## Integrate SDK with 3P App
8484

85-
### Creating a Release Candidate
86-
87-
Change the version field in `gradle.properties` to reflect the RC status:
88-
89-
```properties
90-
version=20.4.1-SNAPSHOT
91-
```
92-
93-
And then generate the library with required libraries:
94-
95-
```bash
96-
# firebase-perf requires firebase-sessions
97-
./gradlew -PprojectsToPublish="firebase-perf,firebase-sessions" firebasePublish
98-
```
99-
100-
This will generate various files in the root build directory that align with
101-
the release candidates.
102-
103-
Alternatively, you can just build the repository in isolation:
104-
```bash
105-
# firebase-perf requires firebase-sessions
106-
./gradlew -PprojectsToPublish="firebase-perf,firebase-sessions" buildMavenZip
107-
```
108-
109-
### Publish project locally
110-
111-
You can publish the project directly to your [local maven](https://docs.gradle.org/current/userguide/declaring_repositories.html#sub:maven_local)
85+
You can publish the SDK directly to your [local maven](https://docs.gradle.org/current/userguide/declaring_repositories.html#sub:maven_local)
11286
repository like so:
11387

11488
```bash
115-
# firebase-perf requires firebase-sessions
116-
./gradlew -PprojectsToPublish="firebase-perf,firebase-sessions" \
117-
publishReleasingLibrariesToMavenLocal
89+
./gradlew :firebase-perf:publishToMavenLocal
11890
```
11991

12092
### Read SDK from mavenLocal()
12193

122-
Add **mavenLocal()** to your project-level `build.gradle` file
123-
124-
```
125-
buildscript {
126-
repositories {
127-
mavenLocal()
128-
google()
129-
jcenter()
130-
}
131-
132-
dependencies {
133-
. . .
134-
135-
# Adds several features that are specific to building Android apps
136-
classpath 'com.android.tools.build:gradle:<agp-version>'
137-
138-
# Required for loading the 'google-services.json' file
139-
classpath 'com.google.gms:google-services:<google-services-plugin-version>'
140-
141-
# Specify the version of 'perf-plugin'
142-
classpath 'com.google.firebase:perf-plugin:<perf-plugin-version>'
143-
}
144-
}
145-
146-
allprojects {
147-
repositories {
148-
mavenLocal()
149-
google()
150-
jcenter()
151-
}
152-
}
153-
```
94+
Add **mavenLocal()** to your project-level `build.gradle` file or `settings.gradle` file based on your app's set up.
15495

155-
### Set Snapshot SDK version
96+
### Set Local SDK version
15697

157-
Add **implementation** dependency to your module-level `build.gradle` file
98+
Add **implementation** dependency to your module-level `build.gradle` file, with the version as defined in `firebase-perf/gradle.properties`.
15899

159100
```
160101
apply plugin: 'com.android.application'
@@ -165,12 +106,11 @@ apply plugin: 'com.google.firebase.firebase-perf'
165106
. . .
166107
167108
dependencies {
168-
implementation 'com.google.firebase:firebase-perf:x.y.z-SNAPSHOT'
109+
implementation 'com.google.firebase:firebase-perf:x.y.z'
169110
}
170111
```
171112

172-
where the version number can be found in `~/.m2/repository/com/google/firebase/firebase-perf/maven-metadata-local.xml`.
173-
See [Reference](https://github.com/firebase/firebase-android-sdk#commands) for detail.
113+
See [Reference](https://github.com/firebase/firebase-android-sdk#commands) for more details.
174114

175115
## Check Code Coverage
176116

0 commit comments

Comments
 (0)