From 4938d7c1339053e073f6bdd0961dd5af441d2230 Mon Sep 17 00:00:00 2001 From: s1gr1d Date: Thu, 5 Dec 2024 14:00:49 +0100 Subject: [PATCH] docs(ci): Add docs for automatic E2E test detection --- dev-packages/e2e-tests/README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/dev-packages/e2e-tests/README.md b/dev-packages/e2e-tests/README.md index e8635447a9a1..919d74e78542 100644 --- a/dev-packages/e2e-tests/README.md +++ b/dev-packages/e2e-tests/README.md @@ -57,8 +57,14 @@ EOF Make sure to add a `test:build` and `test:assert` command to the new app's `package.json` file. -Add the new test app to `test-application` matrix in `.github/workflows/build.yml` for the `job_e2e_tests` job. If you -want to run a canary test, add it to the `canary.yml` workflow. +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`). +The test matrix for CI is generated in `dev-packages/e2e-tests/lib/getTestMatrix.ts`. + +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). +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. + +You can add additional information about the test (e.g. canary versions, optional in CI) by adding `sentryTest` in the `package.json` +of a test application. **An important thing to note:** In the context of the build/test commands the fake test registry is available at `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