Skip to content

Commit 8582502

Browse files
authored
docs(docker): document compose namespace via COMPOSE_PROJECT_NAME (#13178)
1 parent cde86ae commit 8582502

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ The library a project with documentation in `docs`.
1212
- `sh compose.sh <target>` for dependency/bootstrap setup.
1313
- `sh test.sh <target>` for tests.
1414
- **NEVER** run tests via local `npm`.
15+
- For parallel runs in multiple worktrees, set a unique namespace:
16+
- `COMPOSE_PROJECT_NAME=ngmocks_<your-unique-string> sh compose.sh <target>`
17+
- `COMPOSE_PROJECT_NAME=ngmocks_<your-unique-string> sh test.sh <target>`
1518

1619
## Update all package-lock.json
1720

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,16 @@ To develop `ng-mocks` you need to use `bash` and `WSL` in case if you are on Win
5353

5454
- it will take a while, but afterwards you have all dependencies installed
5555

56+
### Docker compose namespace for parallel worktrees
57+
58+
To avoid collisions when multiple worktrees run docker compose in parallel, set `COMPOSE_PROJECT_NAME`.
59+
Use your own unique string for each task/worktree.
60+
61+
```shell
62+
COMPOSE_PROJECT_NAME=ngmocks_<your-unique-string> sh ./compose.sh e2e
63+
COMPOSE_PROJECT_NAME=ngmocks_<your-unique-string> sh ./test.sh e2e
64+
```
65+
5666
## How to run unit tests locally
5767

5868
```shell

0 commit comments

Comments
 (0)