Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add deprecation message #166

Merged
merged 1 commit into from
Dec 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Cypress Playback

## 🚨 This library will only receive security updates until Feb 28, 2025 when it will no longer be maintained. 🚨

**We recommend using Mock Service Worker (MSW) instead of this plugin. MSW solves a similar problem but is more flexible and can be used in a variety of environments including Cypress, Node.js and Jest. For more information, see the [MSW documentation][11].**

---

> :arrows_counterclockwise: **_Automatically record and playback HTTP requests made in
> Cypress tests._**

Expand Down Expand Up @@ -598,3 +604,4 @@ None
[8]:code-of-conduct.md
[9]:https://www.npmjs.com/package/@oreillymedia/cypress-playback
[10]:https://docs.cypress.io/guides/tooling/plugins-guide#Using-a-plugin
[11]:https://mswjs.io/docs/comparison#cypress---cyintercept
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
"scripts": {
"sandbox:open": "cd ./sandbox/ && npm run start:open",
"sandbox:open:playback": "cd ./sandbox/ && npm run start:open:playback",
"sandbox:ci": "cd ./sandbox/ && npm run start:run"
"sandbox:ci": "cd ./sandbox/ && npm run start:run",
"postinstall": "echo '@oreillymedia/cypress-playback - After Feb 28, 2025 this library will no longer be maintained. Please see README for more information.'"


},
"repository": {
"type": "git",
Expand Down
Loading