@camunda/e2e-test-suite 0.0.618 → 0.0.619

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +26 -3
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -586,12 +586,35 @@ Before marking a PR as ready for review:
586
586
  - [ ] Change scope is appropriate — large multi-version changes are split into separate PRs
587
587
  - [ ] A relevant test workflow has been run and **passed**
588
588
  - [ ] The workflow run URL is pasted in the PR description
589
- - [ ] Documentation is updated in TestRail and Confluence if a new test case was added
589
+ - [ ] If new tests were added: add the `testrail-test-case` label after the test run passes to auto-enrich TestRail cases (see [TestRail Integration](#testrail-integration)); update Confluence if applicable
590
590
 
591
591
  ### TestRail Integration
592
592
 
593
- 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.
593
+ Test case documentation in TestRail is **automatically synced** from spec files. When a PR adds or modifies test cases, the sync workflow uses AI (GitHub Copilot) to generate human-readable step descriptions directly from the Playwright test code.
594
594
 
595
- If you do not have access to TestRail, please contact the Test Automation Team to request access.
595
+ #### How to trigger the sync
596
+
597
+ **Option A — Label after a passing test run (recommended)**
598
+
599
+ 1. Run the relevant test workflow and confirm it passes.
600
+ 2. Add the `testrail-test-case` label to the PR.
601
+ 3. The [Sync TestRail Cases](https://github.com/camunda/c8-cross-component-e2e-tests/actions/workflows/sync-testrail-cases.yml) workflow fires automatically, detects the changed spec files, and enriches the matching TestRail cases with AI-generated steps.
602
+
603
+ > Re-triggering is easy: remove the label and add it again.
604
+
605
+ **Option B — Manual dispatch**
606
+
607
+ Go to [Actions → Sync TestRail Cases → Run workflow](https://github.com/camunda/c8-cross-component-e2e-tests/actions/workflows/sync-testrail-cases.yml) and provide the version and spec file path manually. Useful for one-off enrichment without opening a PR.
608
+
609
+ #### What the sync does
610
+
611
+ - Finds the matching TestRail case by automation ID (set by the JUnit reporter) or normalised title.
612
+ - Skips cases that already have steps on the correct template.
613
+ - Re-enriches cases that are on the wrong TestRail template (fixes template + steps in one pass).
614
+ - Calls the GitHub Copilot API to produce Action + Expected Result step rows from the raw Playwright code.
615
+
616
+ #### Access
617
+
618
+ If you do not have access to TestRail, contact the Test Automation Team to request access.
596
619
 
597
620
  Thank you for using the C8 Cross-Component End-to-End Test Suite for Camunda C8 full product stack e2e testing. Happy testing! If you have any questions or need assistance, feel free to reach out to the maintainers for support.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@camunda/e2e-test-suite",
3
- "version": "0.0.618",
3
+ "version": "0.0.619",
4
4
  "description": "End-to-end test helpers for Camunda 8",
5
5
  "repository": {
6
6
  "type": "git",