@@ -141,8 +141,17 @@ Authentication Admin` role at
141
141
[ Google Cloud Platform Console / IAM & admin] ( https://console.cloud.google.com/iam-admin ) . This is
142
142
required to ensure that exported user records contain the password hashes of the user accounts.
143
143
Also obtain the web API key of the project from the "Settings > General" page, and save it as
144
- ` integration_apikey.txt ` at the root of the codebase. Now run the following command to invoke the
145
- integration test suite:
144
+ ` integration_apikey.txt ` at the root of the codebase.
145
+
146
+ Some of the integration tests require an
147
+ [ Identity Platform] ( https://cloud.google.com/identity-platform/ ) project with multi-tenancy
148
+ [ enabled] ( https://cloud.google.com/identity-platform/docs/multi-tenancy-quickstart#enabling_multi-tenancy ) .
149
+ An existing Firebase project can be upgraded to an Identity Platform project without losing any
150
+ functionality via the
151
+ [ Identity Platform Marketplace Page] ( https://console.cloud.google.com/customer-identity ) . Note that
152
+ charges may be incurred for active users beyond the Identity Platform free tier.
153
+
154
+ Now run the following command to invoke the integration test suite:
146
155
147
156
```
148
157
mvn verify
@@ -153,14 +162,14 @@ tests, specify the `-DskipUTs` flag.
153
162
154
163
### Generating API Docs
155
164
156
- Invoke the [ Maven Javadoc plugin] ( https://maven.apache.org/plugins/maven-javadoc-plugin/ ) as
165
+ Invoke the [ Maven Javadoc plugin] ( https://maven.apache.org/plugins/maven-javadoc-plugin/ ) as
157
166
follows to generate API docs for all packages in the codebase:
158
167
159
168
```
160
169
mvn javadoc:javadoc
161
170
```
162
171
163
- This will generate the API docs, and place them in the ` target/site/apidocs ` directory.
172
+ This will generate the API docs, and place them in the ` target/site/apidocs ` directory.
164
173
165
174
To generate API docs for only the public APIs (i.e. ones that are not marked with ` @hide ` tags),
166
175
you need to trigger the ` devsite-apidocs ` Maven profile. This profile uses Maven Javadoc plugin
0 commit comments