@yasserkhanorg/impact-gate 2.1.5 → 2.1.6

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 +23 -4
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @yasserkhanorg/impact-gate
2
2
 
3
- Diff-aware E2E impact analysis and coverage gating for Playwright/Cypress teams. Optional AI features can suggest, generate, and heal tests once your project has a route-families.json manifest.
3
+ Diff-aware E2E impact analysis, release-ready test planning, and coverage gating for Playwright/Cypress teams. Optional AI features can suggest, generate, and heal tests once your project has a route-families.json manifest.
4
4
 
5
5
  [![npm](https://img.shields.io/npm/v/%40yasserkhanorg%2Fimpact-gate)](https://www.npmjs.com/package/@yasserkhanorg/impact-gate)
6
6
  [![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
@@ -8,7 +8,16 @@ Diff-aware E2E impact analysis and coverage gating for Playwright/Cypress teams.
8
8
 
9
9
  ## What It Does
10
10
 
11
- `impact-gate` is built first for one painful CI job: given a git diff, tell us which E2E surface changed and whether the current suite already covers it.
11
+ `impact-gate` is built first for one painful CI job: given a git diff, tell us which E2E surface changed, whether the current suite already covers it, and what still needs testing before we merge or ship.
12
+
13
+ That same workflow works for:
14
+
15
+ - pull requests against `main`
16
+ - release branches against the previous release tag
17
+ - hotfixes against the last shipped version
18
+ - any "what changed between these refs?" release-readiness check
19
+
20
+ Product priorities:
12
21
 
13
22
  - **Primary**: diff-aware E2E impact analysis and coverage gating
14
23
  - **Secondary**: optional AI features can suggest, generate, and heal tests once your project has a route-families.json manifest
@@ -26,7 +35,7 @@ Transition note:
26
35
 
27
36
  | Level | Commands | What They Are For |
28
37
  |------|----------|-------------------|
29
- | Core CI Workflow | `impact`, `plan`, `gate` | Decide what changed, what is covered, and whether a PR should pass |
38
+ | Core CI Workflow | `impact`, `plan`, `gate` | Decide what changed, what is covered, and whether a PR should pass or a release is ready |
30
39
  | Optional AI Workflow | `generate`, `heal`, `analyze`, `finalize-generated-tests` | Suggest, create, or repair tests after impact analysis |
31
40
  | Setup and Calibration | `train`, `bootstrap`, `traceability-*`, `feedback`, `cost-report`, `llm-health` | Build the manifest, feed execution data back in, and inspect cost/provider health |
32
41
  | Advanced / Experimental | `crew`, MCP mode, plugins, `impact-gate-qa` | Deeper orchestration and browser-driven workflows beyond the core CI loop |
@@ -77,7 +86,7 @@ npx impact-gate --help
77
86
  Then run the core CI workflow:
78
87
 
79
88
  ```bash
80
- # 1. See what changed
89
+ # 1. See what changed in a PR or branch diff
81
90
  npx impact-gate impact --path /path/to/project --since origin/main
82
91
 
83
92
  # 2. Build a coverage plan and CI summary artifacts
@@ -87,10 +96,20 @@ npx impact-gate plan --path /path/to/project --since origin/main
87
96
  npx impact-gate gate --path /path/to/project --threshold 80
88
97
  ```
89
98
 
99
+ Use the same `plan` command for release readiness:
100
+
101
+ ```bash
102
+ # Compare the current branch or release candidate to the last shipped tag
103
+ npx impact-gate plan --path /path/to/project --since v2.1.0
104
+ ```
105
+
106
+ That gives you a release-focused test plan showing impacted flows, current coverage, and where you still need tests or validation before shipping.
107
+
90
108
  Notes:
91
109
 
92
110
  - `impact` prints a deterministic summary to stdout.
93
111
  - `plan` writes `.e2e-ai-agents/plan.json` and `.e2e-ai-agents/ci-summary.md`.
112
+ - `plan --since <old-release-tag>` is the simplest way to turn a release diff into a prioritized test plan.
94
113
  - `gate` expects a threshold in the range `0-100` and exits `1` when the threshold is missed.
95
114
  - Add the Optional AI Workflow only after your `route-families.json` manifest is useful enough to trust.
96
115
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@yasserkhanorg/impact-gate",
3
- "version": "2.1.5",
4
- "description": "Diff-aware E2E impact analysis and coverage gating for Playwright/Cypress teams. Optional AI features can suggest, generate, and heal tests once your project has a route-families.json manifest.",
3
+ "version": "2.1.6",
4
+ "description": "Diff-aware E2E impact analysis, release-ready test planning, and coverage gating for Playwright/Cypress teams. Optional AI features can suggest, generate, and heal tests once your project has a route-families.json manifest.",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/esm/index.js",
7
7
  "types": "dist/index.d.ts",