Skip to content

Commit a26fae8

Browse files
committed
feat(ORC-8134): add migration plan for ORMContext
1 parent ecf71ac commit a26fae8

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,11 @@ default:
5555
5656
> If you also want to use `ORMContext`, install [macpaw/behat-orm-context](https://github.com/macpaw/behat-orm-context) and follow its setup instructions.
5757

58+
> 📄 **Migration Notice:** `OrmContext` will be removed from `behat-api-context` in the next major release.
59+
> Please migrate to [`behat-orm-context`](https://github.com/macpaw/behat-orm-context) using the [official migration guide](https://github.com/macpaw/behat-orm-context/blob/master/MIGRATION.md) to avoid test failures.
60+
> See the full [ORMContext Migration Plan](./docs/ormcontext-migration.md) for step-by-step instructions.
61+
62+
5863
---
5964

6065
## Configuration

docs/ormcontext-migration.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Migration plan for using ORMContext
2+
3+
### Step 1: 📦 Add `behat-orm-context` to `composer.json`
4+
```bash
5+
composer require --dev macpaw/behat-orm-context
6+
```
7+
8+
### Step 2: 🧩 Register `OrmContext` in `behat.yml`
9+
```yaml
10+
default:
11+
suites:
12+
default:
13+
contexts:
14+
- BehatOrmContext\Context\OrmContext
15+
16+
```
17+
> If you previously used `BehatApiContext\Context\OrmContext`, replace it with `BehatOrmContext\Context\OrmContext`
18+
19+
### Step 3: 🧪 Verify Scenarios
20+
1. Run Behat tests:
21+
```bash
22+
vendor/bin/behat
23+
```
24+
25+
2. Ensure that all steps previously relying on OrmContext still work correctly after the migration.
26+
27+
### 🚨 Backward Compatibility Notice
28+
> `OrmContext` will be removed from `behat-api-context` in a future major release. If you don't migrate, your tests will break after updating dependencies.
29+
30+
### 🔔 Recommendation
31+
Perform the migration before the next major release of `behat-api-context` to avoid CI/CD disruptions and unexpected test failures in your production pipeline.

0 commit comments

Comments
 (0)