@camunda/e2e-test-suite 0.0.533 → 0.0.534

package/README.md

@@ -515,13 +515,79 @@ folder locally and to TestRail in the CI.
 
 Contributions to the C8 Cross-Component End-to-End Test Suite are welcome! If you find any issues or want to add new test cases, please submit a pull request or open an issue on GitHub.
 
-To contribute, please follow these guidelines:
+General guidelines:
 
 - Anyone can contribute.
-- The reviewer of the pull request must be someone from the Test Automation Team
+- The reviewer of the pull request must be someone from the Test Automation Team.
 - Test cases must adhere to the Page Object Model design pattern.
 - Test cases must involve multiple C8 components.
 
+### Multi-version PRs
+
+Tests and page objects are organized by platform and minor version (e.g. `tests/8.9/`, `tests/8.10/`, `tests/SM-8.9/`).
+
+| Change type | Recommendation |
+|---|---|
+| Small mechanical fix (e.g. selector rename, one-liner) applied consistently across versions | Acceptable in a single PR — note it in the PR description |
+| New test, new helper, or any change that requires review of logic per-version | **Split into one PR per version** |
+| Refactoring or structural change | **Split into one PR per version** |
+
+Reviewers are expected to understand the context of each version they review. Large multi-version PRs make meaningful review impractical and hide regressions. When in doubt, split.
+
+**How to split:**
+
+1. Create a branch per version: `feat/my-change-8-9`, `feat/my-change-8-10`, etc.
+2. Apply your change to the first branch and open a PR.
+3. Cherry-pick or re-apply to subsequent branches and open follow-up PRs.
+4. Link the sibling PRs in each description for traceability.
+
+### Test runs before review
+
+**Do not request a review — and do not assign reviewers — until a successful test run is linked in your PR.**
+
+This applies to all changes that touch test specs, page objects, fixtures, or utilities.
+
+#### Automatic test runs on PR
+
+The [SaaS/SM/C8Run PR](https://github.com/camunda/c8-cross-component-e2e-tests/actions/workflows/playwright.yml) workflow runs automatically on every pull request. It detects which `tests/` and `pages/` sub-directories have changed and runs the tests for those versions/platforms.
+
+**This works reliably only when a PR touches a single version and a single platform.** Examples that work automatically:
+
+- Only `tests/8.10/` and/or `pages/8.10/` are changed → 8.10 SaaS tests run.
+- Only `tests/SM-8.9/` and/or `pages/SM-8.9/` are changed → SM-8.9 tests run.
+
+If no `tests/` or `pages/` folders are changed (e.g. infrastructure or tooling changes), the test run is skipped automatically — state this explicitly in the PR description.
+
+#### When you must trigger tests manually
+
+The automatic PR workflow **does not reliably cover** changes that span multiple versions or multiple platforms. In those cases you must trigger the relevant on-demand workflows manually — or, preferably, split the PR (see [Multi-version PRs](#multi-version-prs) above).
+
+| Scenario | Action required |
+|---|---|
+| Only one version and one platform changed | Wait for the automatic PR workflow |
+| Multiple SaaS versions changed (e.g. `8.9` + `8.8`) | Trigger [SaaS On-Demand](https://github.com/camunda/c8-cross-component-e2e-tests/actions/workflows/playwright_saas_manual.yml) separately for each version, **or split the PR** |
+| Multiple SM versions changed (e.g. `SM-8.9` + `SM-8.8`) | Trigger [SM On-Demand ≥8.8](https://github.com/camunda/c8-cross-component-e2e-tests/actions/workflows/playwright_sm_manual_install_8_8_plus.yml) or [SM On-Demand ≤8.7](https://github.com/camunda/c8-cross-component-e2e-tests/actions/workflows/playwright_sm_manual.yml) separately for each version, **or split the PR** |
+| SaaS + SM versions changed together (e.g. `8.9` + `SM-8.8`) | Trigger both the SaaS and SM on-demand workflows, **or split the PR** |
+| Connector tests | [SaaS Connectors](https://github.com/camunda/c8-cross-component-e2e-tests/actions/workflows/playwright_saas_connectors.yml) or the relevant SM connector workflow |
+| C8 Run tests (`tests/c8Run-8.x/`) | [C8Run On-Demand Linux](https://github.com/camunda/c8-cross-component-e2e-tests/actions/workflows/playwright_c8Run_tests_manual_linux.yml) |
+
+#### Steps
+
+1. Wait for the automatic PR workflow to complete **or** trigger the relevant on-demand workflow(s) manually.
+2. Confirm each run passes (or document known flakiness with a re-run showing it as non-deterministic).
+3. Paste every workflow run URL in the **Definition of Done** section of the PR before assigning reviewers.
+
+Reviewers are expected to verify that a passing run for every changed version/platform is linked before approving.
+
+### PR checklist summary
+
+Before marking a PR as ready for review:
+
+- [ ] Change scope is appropriate — large multi-version changes are split into separate PRs
+- [ ] A relevant test workflow has been run and **passed**
+- [ ] The workflow run URL is pasted in the PR description
+- [ ] Documentation is updated in TestRail and Confluence if a new test case was added
+
 ### TestRail Integration
 
 To ensure our test case documentation on TestRail remains up-to-date, if a PR contains updates to any test file or page file, the associated TestRail test case must be linked in the PR description.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camunda/e2e-test-suite",
-  "version": "0.0.533",
+  "version": "0.0.534",
   "description": "End-to-end test helpers for Camunda 8",
   "repository": {
     "type": "git",