@devassure/cli 1.0.15 → 1.1.1

package/README.md

@@ -131,6 +131,21 @@ default:
   - **Note**: If `--filter`/`--filters` is provided, all other filter parameters (`--tag`, `--priority`, `--folder`, `--query`) are ignored
   - Alias: `devassure run` (same options apply)
 
+### E2E Test from Git Code Changes
+
+- **`devassure test`** — Run tests scoped to **git code changes** (branch comparison or a specific commit). Uses the same test case discovery as `run-tests` (current directory as test cases root), but tells the agent which branch or commit to focus on.
+  - `--path <path>` — Project path (default: current directory)
+  - `--head <branch name>` — **Source** branch (changes under test); forwarded to the agent as `--source`. Optional when using branch mode.
+  - `--base <branch name>` — **Target** branch (baseline to compare against, usually the repo default); forwarded as `--target`. Optional when using branch mode.
+  - `--commit <commitId>` — Commit to test; forwarded as `--commit-id`. Use this for commit mode instead of `--head` / `--base`.
+  - `--archive <folder>` — Archive folder path; after the run, test reports are written as `devassure-results-<session-id>.zip` in this folder
+  - `--environment <env>` — Environment name (e.g. staging, production)
+  - `--url <url>` — Override default test URL (`test_data.default.url` and TEST DATA section)
+  - `--headless <bool>` — Run browser headless: `true` or `false` (omit for project default)
+  - **Branch vs commit**: If you pass any of `--head`, `--base`, or `--commit`, that mode is enabled. Omitting all three is equivalent to “no explicit ref”: the agent uses **current branch** as the source and the **repository default branch** as the target.
+
+### Resume Test Session
+
 - **`devassure resume`** - Resume an existing test session by session ID
   - `--session-id <session-id>` - Session ID to resume (one of these or `--last` is required)
   - `--last` - Resume the last executed session
@@ -196,6 +211,19 @@ devassure run-tests
 devassure open-report --last
 ```
 
+### E2E Test from Git Code Changes
+
+```bash
+# 1. Test the diff of current branch vs default branch
+devassure test
+
+# 2. Explicit source and target branches
+devassure test --head feature/login --base main
+
+# 3. Test a specific commit
+devassure test --commit abc1234567890
+```
+
 ### Cleanup
 
 ```bash
@@ -414,7 +442,7 @@ tags:
 
 ## Actions
 
-Actions group steps that can be reused across multiple tests. Add action YAML files under `.devassure/actions/`. To call an action, use its **name** as a step in a test file.
+Actions group steps that can be reused across multiple tests. Add action YAML files under actions folder - `.devassure/actions/<action_name>.yaml`. To call an action, use its **name** as a step in a test file.
 
 **Fields in an action file:**
 
@@ -645,6 +673,52 @@ tools:
       npm run cleanupTestingProcess
 ```
 
+## Advanced test_data.
+
+You can keep large or reusable `test_data` in separate YAML files and merge them into your scenario config using `!include`, so teams can share the same data across multiple scenarios/environments.
+This works for both **single values** (strings/numbers/booleans) and **arrays of values** (e.g., multiple cards, multiple admin users, multiple payment methods).
+
+### Examples
+
+#### Reusable actions YAML (multiple actions in one file)
+
+```yaml
+# .devassure/actions/cart.yaml
+- name: go_to_carts_page
+  description: Go to the carts page and verify the content
+  steps:
+    - Click on the carts icon
+    - Verify the carts page is opened
+
+- name: add_to_cart
+  description: Add a product to the cart
+  steps:
+    - Click on the add to cart button
+    - Verify the product is added to the cart
+```
+
+#### Reusable actions YAML (single action in one file)
+
+```yaml
+# .devassure/actions/products.yaml
+name: remove_from_cart
+description: Remove a product from the cart
+steps:
+  - Click on the remove button for the product
+  - Verify the product is removed from the cart
+```
+
+#### Include reusable test_data into your test_data config
+
+```yaml
+# .devassure/test_data.yaml
+default:
+  url: http://127.0.0.1:4321
+
+  cart:
+    <<: !include test_data/cart.yaml
+```
+
 ## Proxy
 
 If the `HTTP_PROXY` or `HTTPS_PROXY` environment variables are set, the CLI will use them to proxy requests.