Skip to content

chore: add beginning of migration guide for Cypress 15 #6159

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Apr 28, 2025
Merged

chore: add beginning of migration guide for Cypress 15 #6159

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6738766
chore: add begining of migration guide for Cypress 15
AtofStryker Apr 22, 2025
0f34f9a
Update docs/app/references/migration-guide.mdx
AtofStryker Apr 24, 2025
e5bf284
Update docs/app/references/migration-guide.mdx
AtofStryker Apr 24, 2025
59c4394
Update docs/app/references/migration-guide.mdx
AtofStryker Apr 25, 2025
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
45 changes: 45 additions & 0 deletions docs/app/references/migration-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,51 @@ sidebar_label: 'Migration Guide'

# Migration Guide

## Migrating to Cypress 15.0

This guide details the code changes needed to migrate to Cypress
version 15.
[See the full changelog for version v14.0](/app/references/changelog#15-0-0).

### Node.js 20 and 22+ support

Cypress comes bundled with its own
[Node.js version](https://github.com/cypress-io/cypress/blob/develop/.node-version).
However, installing the `cypress` npm package uses the Node.js version installed
on your system.

[See Node's release schedule](https://github.com/nodejs/Release). Node.js
version 18 and 23 will no longer be supported when installing Cypress. The minimum Node.js
version supported to install Cypress is Node.js 20 and 22+.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[See Node's release schedule](https://github.com/nodejs/Release). Node.js
version 18 and 23 will no longer be supported when installing Cypress. The minimum Node.js
version supported to install Cypress is Node.js 20 and 22+.
[See Node's release schedule](https://github.com/nodejs/Release). Node.js
version 18 and 23 are no longer supported when installing Cypress. The supported Node.js
versions to install Cypress are now Node.js 20 and 22+.

You can't really have two minimums.
Node.js v24.0.0 was supposed be released today, however they are having compatibility issues with a newer V8 engine and the release is delayed. I'll drop a note if there is any new planning date available.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point. Once it releases we need to test Cypress out with it to see if anything is broken


### Angular `17` CT no longer supported

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`.

#### To continue using Angular below 18.0.0

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`.

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+.

```sh
npm install --save-dev @cypress/angular@3
```

Inside your support file (ex: `./cypress/support/component.(js|ts)`), or wherever your mount function is imported, make the following update to add `@`.

<Badge type="danger">Before</Badge>{' '}

```ts
import { mount } from `cypress/angular`
```

<Badge type="success">After</Badge>

```ts
import { mount } from `@cypress/angular`
```

## Migrating to Cypress 14.0

This guide details the code changes needed to migrate to Cypress
Expand Down