Skip to content

Commit 458cc7c

Browse files
committed
docs: document the new options
1 parent aa4c29c commit 458cc7c

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

docs/modules/firebase.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,6 @@ go get github.com/testcontainers/testcontainers-go/modules/firebase
2626

2727
- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
2828

29-
!!!info
30-
The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
31-
3229
The Firebase module exposes one entrypoint function to create the Firebase container, and this function receives three parameters:
3330

3431
```golang
@@ -50,6 +47,24 @@ E.g. `Run(context.Background(), "ghcr.io/u-health/docker-firebase-emulator:13.29
5047

5148
{% include "../features/common_functional_options.md" %}
5249

50+
#### WithRoot
51+
52+
- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
53+
54+
If you need to set a different Firebase root directory, you can use the `WithRoot` option.
55+
E.g. `firebase.Run(context.Background(), "ghcr.io/u-health/docker-firebase-emulator:13.29.2", firebase.WithRoot("testdata/firebase"))`.
56+
57+
!!! warning
58+
The root directory must be a valid Firebase project directory, including the `firebase.json` file.
59+
60+
#### WithCache
61+
62+
- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
63+
64+
If you need to enable the Firebase cache, you can use the `WithCache` option, which enables the binary cache based on the Testcontainers SessionID (meaningful only when multiple tests are used).
65+
66+
E.g. `firebase.Run(context.Background(), "ghcr.io/u-health/docker-firebase-emulator:13.29.2", firebase.WithCache())`.
67+
5368
### Container Methods
5469

5570
The Firebase container exposes the following methods:

0 commit comments

Comments
 (0)