Skip to content

Commit

Permalink
docs(misc): add info about running E2E in CI-like env to CONTRIBUTING (
Browse files Browse the repository at this point in the history
  • Loading branch information
meeroslav authored Dec 9, 2022
1 parent ecf9a80 commit 2ff6b11
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ nx test jest

### Running E2E Tests

**Use Node 14 and NPM 6. E2E tests won't work on Node 15 and NPM 7.**
**Use Node 16 and NPM 8. E2E tests won't work on Node 15 and NPM 7.**

To make sure your changes do not break any E2E tests, run:

Expand All @@ -133,6 +133,14 @@ Running E2E tests can take some time, so it is often useful to run a single test
nx e2e e2e-cli -t versions # I often add qqqq to my test name so I can use -t qqqq
```

Sometimes tests pass locally but they fail on the CI. To reproduce the CI environment and be able to debug the issue, run:

```bash
NX_VERBOSE_LOGGING=true CI=true PACKAGE_MANAGER=pnpm yarn nx e2e e2e-cli --t="should do something is this test"
```

The above command sets verbose logging (this exposes stack traces and underlying errors), sets the defaults to be CI-like and sets Pnpm as the selected package manager.

### Developing on Windows

To build Nx on Windows, you need to use WSL.
Expand Down

0 comments on commit 2ff6b11

Please sign in to comment.