Skip to content

Commit 4fa879e

Browse files
chore: add beginning of migration guide for Cypress 15 (#6159)
* chore: add begining of migration guide for Cypress 15 * Update docs/app/references/migration-guide.mdx Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> * Update docs/app/references/migration-guide.mdx Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> * Update docs/app/references/migration-guide.mdx Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> --------- Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
1 parent becd3da commit 4fa879e

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

docs/app/references/migration-guide.mdx

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,46 @@ sidebar_label: 'Migration Guide'
88

99
# Migration Guide
1010

11+
## Migrating to Cypress 15.0
12+
13+
This guide details the code changes needed to migrate to Cypress
14+
version 15.
15+
[See the full changelog for version v15.0](/app/references/changelog#15-0-0).
16+
17+
### Node.js 20 and 22+ support
18+
19+
Cypress requires [Node.js](https://nodejs.org/en) in order to install the Cypress binary and the supported versions are now Node.js 20 and 22+.
20+
Node.js versions 18 and 23 are no longer supported.
21+
[See Node's release schedule](https://github.com/nodejs/Release).
22+
23+
### Angular `17` CT no longer supported
24+
25+
With [LTS ending](https://angular.dev/reference/releases#actively-supported-versions) for Angular 17, the minimum required Angular version for component testing is now `18.0.0`.
26+
27+
#### To continue using Angular below 18.0.0
28+
29+
If you haven't been able to migrate away from an older Angular version and still need that test harness, it can be installed independently via the [`@cypress/angular`](https://www.npmjs.com/package/@cypress/angular) `3.x.x` package from `npm`.
30+
31+
Note that this test harness version is deprecated and no longer supported by Cypress. This version is intended to serve as a temporary workaround to migrate your project to Angular v18.0.0+.
32+
33+
```sh
34+
npm install --save-dev @cypress/angular@3
35+
```
36+
37+
Inside your support file (ex: `./cypress/support/component.(js|ts)`), or wherever your mount function is imported, make the following update to add `@`.
38+
39+
<Badge type="danger">Before</Badge>{' '}
40+
41+
```ts
42+
import { mount } from `cypress/angular`
43+
```
44+
45+
<Badge type="success">After</Badge>
46+
47+
```ts
48+
import { mount } from `@cypress/angular`
49+
```
50+
1151
## Migrating to Cypress 14.0
1252

1353
This guide details the code changes needed to migrate to Cypress

0 commit comments

Comments
 (0)