Skip to content

Commit f4970f1

Browse files
authored
docs(ci): Add docs for automatic E2E test detection (#14593)
Updates readme based on this PR: #14254
1 parent 745775e commit f4970f1

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

dev-packages/e2e-tests/README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,14 @@ EOF
5757

5858
Make sure to add a `test:build` and `test:assert` command to the new app's `package.json` file.
5959

60-
Add the new test app to `test-application` matrix in `.github/workflows/build.yml` for the `job_e2e_tests` job. If you
61-
want to run a canary test, add it to the `canary.yml` workflow.
60+
Test apps in the folder `test-applications` will be automatically picked up by CI in the job `job_e2e_tests` (in `.github/workflows/build.yml`).
61+
The test matrix for CI is generated in `dev-packages/e2e-tests/lib/getTestMatrix.ts`.
62+
63+
For each test app, CI checks its dependencies (and devDependencies) to see if any of them have changed in the current PR (based on nx affected projects).
64+
For example, if something is changed in the browser package, only E2E test apps that depend on browser will run, while others will be skipped.
65+
66+
You can add additional information about the test (e.g. canary versions, optional in CI) by adding `sentryTest` in the `package.json`
67+
of a test application.
6268

6369
**An important thing to note:** In the context of the build/test commands the fake test registry is available at
6470
`http://127.0.0.1:4873`. It hosts all of our packages as if they were to be published with the state of the current

0 commit comments

Comments
 (0)