@taqwright/lime-cli 0.33.0 → 0.35.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.
Files changed (3) hide show
  1. package/README.md +27 -0
  2. package/dist/index.js +306 -264
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -512,6 +512,33 @@ id-like name reports under its own name, and `report` says which. An explicit
512
512
  { "testCasePlan": "qa/flows.csv", "testCaseId": "\\[(TC-\\d+)\\]" }
513
513
  ```
514
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, runs_after,
524
+ steps, expected, platforms`; `runs_after` lists the ids of the flows a flow starts after, which
525
+ the board draws as arrows), always shows LIME's dry run first, and changes the board only with
526
+ `--yes`. A flow keeps its card across imports by its id. `--sync` retires flows the file no
527
+ longer lists (hidden, history kept, back if the id returns) and refuses to retire more than a
528
+ third of the plan unless `--force`. To keep the board in step with the repo, run it on every
529
+ merge that changes the plan:
530
+
531
+ ```yaml
532
+ on: { push: { branches: [main], paths: [docs/e2e-flows.csv] } }
533
+ jobs:
534
+ sync-flows:
535
+ runs-on: ubuntu-latest
536
+ steps:
537
+ - uses: actions/checkout@v4
538
+ - run: npx @taqwright/lime-cli scenarios import --sync --yes
539
+ env: { LIME_CI_TOKEN: "${{ secrets.LIME_CI_TOKEN }}" }
540
+ ```
541
+
515
542
  #### Which build was under test
516
543
 
517
544
  `--app-version` is what lets LIME tell an intended UI change from a bug: a locator that