@taqwright/lime-cli 0.32.2 → 0.34.0
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.
- package/README.md +47 -0
- package/dist/index.js +318 -270
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -491,6 +491,53 @@ annotation that ties a test to its card. JUnit XML carries neither, so LIME matc
|
|
|
491
491
|
by spec path instead — run a repo scan (console → Scenarios → Sync) once, and it knows
|
|
492
492
|
which file holds which journey.
|
|
493
493
|
|
|
494
|
+
#### Results onto the flows you planned
|
|
495
|
+
|
|
496
|
+
When your flows are a plan, `docs/e2e-flows.csv` with an `id` column (imported in the console
|
|
497
|
+
under Scenarios → Import), name each test after its flow's id and its result lands on that
|
|
498
|
+
flow's card, from any runner:
|
|
499
|
+
|
|
500
|
+
| Runner | Test name |
|
|
501
|
+
|---|---|
|
|
502
|
+
| JUnit 5 | `void E2E_07_checkoutWithPromoCode()` |
|
|
503
|
+
| Cucumber | `Scenario: E2E-07 Checkout with a promo code` |
|
|
504
|
+
| taqwright / Playwright | `test('E2E-07 checkout with a promo code', …)` |
|
|
505
|
+
|
|
506
|
+
`_` counts as `-`, so a Java method can carry the id. Only ids the plan lists count: any other
|
|
507
|
+
id-like name reports under its own name, and `report` says which. An explicit
|
|
508
|
+
`taqwright-scenario` annotation still wins. A plan elsewhere, or ids written differently, go in
|
|
509
|
+
`lime.json` (`testCaseId` is a regex; its first group is the id when it has one):
|
|
510
|
+
|
|
511
|
+
```json
|
|
512
|
+
{ "testCasePlan": "qa/flows.csv", "testCaseId": "\\[(TC-\\d+)\\]" }
|
|
513
|
+
```
|
|
514
|
+
|
|
515
|
+
#### Your flow plan on the board, from the command line
|
|
516
|
+
|
|
517
|
+
```bash
|
|
518
|
+
lime-cli scenarios list # each flow, and its last result per platform
|
|
519
|
+
lime-cli scenarios import # dry run of docs/e2e-flows.csv
|
|
520
|
+
lime-cli scenarios import --sync --yes # apply; retire flows the file no longer lists
|
|
521
|
+
```
|
|
522
|
+
|
|
523
|
+
`import` reads the plan by its column names (`id, flow, covers, feature, persona, steps,
|
|
524
|
+
expected, platforms`), always shows LIME's dry run first, and changes the board only with
|
|
525
|
+
`--yes`. A flow keeps its card across imports by its id. `--sync` retires flows the file no
|
|
526
|
+
longer lists (hidden, history kept, back if the id returns) and refuses to retire more than a
|
|
527
|
+
third of the plan unless `--force`. To keep the board in step with the repo, run it on every
|
|
528
|
+
merge that changes the plan:
|
|
529
|
+
|
|
530
|
+
```yaml
|
|
531
|
+
on: { push: { branches: [main], paths: [docs/e2e-flows.csv] } }
|
|
532
|
+
jobs:
|
|
533
|
+
sync-flows:
|
|
534
|
+
runs-on: ubuntu-latest
|
|
535
|
+
steps:
|
|
536
|
+
- uses: actions/checkout@v4
|
|
537
|
+
- run: npx @taqwright/lime-cli scenarios import --sync --yes
|
|
538
|
+
env: { LIME_CI_TOKEN: "${{ secrets.LIME_CI_TOKEN }}" }
|
|
539
|
+
```
|
|
540
|
+
|
|
494
541
|
#### Which build was under test
|
|
495
542
|
|
|
496
543
|
`--app-version` is what lets LIME tell an intended UI change from a bug: a locator that
|