Skip to content

Commit ece0030

Browse files
authored
Indicate how to get set up for the multitenancy integration tests. (#393)
This documentation is based off of the instructions in https://github.com/firebase/firebase-admin-node/blob/master/CONTRIBUTING.md.
1 parent fadc2d3 commit ece0030

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,17 @@ Authentication Admin` role at
141141
[Google Cloud Platform Console / IAM & admin](https://console.cloud.google.com/iam-admin). This is
142142
required to ensure that exported user records contain the password hashes of the user accounts.
143143
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:
146155

147156
```
148157
mvn verify
@@ -153,14 +162,14 @@ tests, specify the `-DskipUTs` flag.
153162

154163
### Generating API Docs
155164

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
157166
follows to generate API docs for all packages in the codebase:
158167

159168
```
160169
mvn javadoc:javadoc
161170
```
162171

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.
164173

165174
To generate API docs for only the public APIs (i.e. ones that are not marked with `@hide` tags),
166175
you need to trigger the `devsite-apidocs` Maven profile. This profile uses Maven Javadoc plugin

0 commit comments

Comments
 (0)