Skip to content

docs: Breaking: Cypress 15.0.0 #6137

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

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open

docs: Breaking: Cypress 15.0.0 #6137

wants to merge 18 commits into from

Conversation

jennifer-shehane
Copy link
Member

@jennifer-shehane jennifer-shehane commented Mar 31, 2025

⚠️ DO NOT MERGE.

Docs for cypress-io/cypress#31408

@jennifer-shehane jennifer-shehane marked this pull request as draft March 31, 2025 13:51
Copy link

cypress bot commented Mar 31, 2025

cypress-documentation    Run #516

Run Properties:  status check errored Errored #516  •  git commit b4b05f6286: baseline updates for Cypress Studio updates
Project cypress-documentation
Branch Review release/15.0.0
Run status status check errored Errored #516
Run duration 03m 53s
Commit git commit b4b05f6286: baseline updates for Cypress Studio updates
Committer Jennifer Shehane
View all properties for this run ↗︎

Test results
Tests that failed  Failures 1
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 11
Tests that passed  Passing 294
View all changes introduced in this branch ↗︎

Warning

Partial Report: The results for the Application Quality reports may be incomplete.

UI Coverage  16.31%
  Untested elements 1046  
  Tested elements 3  
Accessibility  97.17%
  Failed rules  1 critical   2 serious   4 moderate   0 minor
  Failed elements 13  

@jennifer-shehane jennifer-shehane self-assigned this Apr 7, 2025
* Update Node.js versions that will be supported for 15

* update lowest npm version supported
AtofStryker and others added 11 commits April 22, 2025 14:15
* chore: remove ts-node references and workarounds and replace them with tsx

* add empty changelog entry for 15 to allow for linked out changes to build
* chore: add begining of migration guide for Cypress 15

* Update docs/app/references/migration-guide.mdx

Co-authored-by: Mike McCready <[email protected]>

* Update docs/app/references/migration-guide.mdx

Co-authored-by: Mike McCready <[email protected]>

* Update docs/app/references/migration-guide.mdx

Co-authored-by: Mike McCready <[email protected]>

---------

Co-authored-by: Mike McCready <[email protected]>
* Add Windows 2025 to supported OS list (#6142)

* New user roles and permissions defined (#6143)

* chore: release 14.3.0 documentation (#6144)

* feat: documentation for the press() command (#6135)

* docs for the press() command, including a callout in the accessibility guide

* add press to TOC

* Move some content around, mention accesiibility

* remove 'focus' note

* Document Keyboard.Keys

* update reference to command

* Update example to be a little more real case

* Add another example of autocomplete with tab

* Add link to keyboard api page

* Fix version number for introduction

* Fix broken link

* alphabetize see also

* Update package.json

Co-authored-by: Mike McCready <[email protected]>

* Fix broken link

* lint

---------

Co-authored-by: Jennifer Shehane <[email protected]>
Co-authored-by: Mike McCready <[email protected]>

* chore: add 14.3.0 changelog to documentation

* Update docs/app/guides/accessibility-testing.mdx

* Update docs/app/references/changelog.mdx

Co-authored-by: Bill Glesias <[email protected]>

---------

Co-authored-by: Cacie Prins <[email protected]>
Co-authored-by: Jennifer Shehane <[email protected]>
Co-authored-by: Mike McCready <[email protected]>

* Correct parameter usage for click() in shadow.mdx (#6145)

* Update shadow.mdx

- Update the suggestion to pass 'top' to cy.click() using the options defined in cy.click()'s documentation

* Update shadow.mdx

Add missing quote

* Update shadow.mdx

One-line for prettier reasons

* Correct command syntax (#6148)

Adds the missing `s` to `Cypress.Command.overwrite()`

* extend pnpm config instructions (#6149)

* fix cy.origin() "yielding a value" example (#6152)

* Update results-api.mdx (#6150)

* chore: add 14.3.1 changelog (#6153)

* chore: add 14.3.1 changelog

* Update docs/app/references/changelog.mdx

Co-authored-by: Mike McCready <[email protected]>

* empty commit to rekick build

---------

Co-authored-by: Mike McCready <[email protected]>

* docs: harmonize on injectDocumentDomain removal in future version (#6154)

* Add experimentalSessionAndOrigin removed comment to origin video (#6158)

* Fix "cy.visit() succeeded, but commands are timing out" error example (#6157)

* Cross-link cy.origin and injectDocumentDomain (#6156)

* chore: add cypress 14.3.2 changelog (#6160)

* Change 'add on' to 'premium solution' for UI Cov & a11y products (#6162)

* UI Coverage and Branch Review updates (#6167)

* add AQ links and button space

* use onlinks for demo vids

* update Cypress

* content updates

* content tweaks

* add last images

* lint-fix

* simplify

* add detail view docs and clean up

* lint fix

* Update docs/cloud/get-started/introduction.mdx

Co-authored-by: Mike McCready <[email protected]>

* Update docs/ui-coverage/core-concepts/compare-reports.mdx

Co-authored-by: Mike McCready <[email protected]>

* Update docs/ui-coverage/core-concepts/compare-reports.mdx

Co-authored-by: Mike McCready <[email protected]>

* revert cypress version bump

* restore package-lock

* remove yarn lockfile

* Update docs/app/get-started/why-cypress.mdx

Co-authored-by: Tyler Biethman <[email protected]>

* Update docs/cloud/features/branch-review.mdx

Co-authored-by: Tyler Biethman <[email protected]>

* Update docs/cloud/features/branch-review.mdx

Co-authored-by: Tyler Biethman <[email protected]>

---------

Co-authored-by: Mike McCready <[email protected]>
Co-authored-by: Tyler Biethman <[email protected]>

* chore: add 14.3.3 changelog (#6171)

* chore: add 14.3.3 changelog

* Update docs/app/references/changelog.mdx

Co-authored-by: Matt Schile <[email protected]>

---------

Co-authored-by: Matt Schile <[email protected]>

* Rework instructions for missing Cypress binary in CI (#6170)

* Node.js 18 EOL (#6165)

* Add quoting advice for PowerShell CLI options (#6169)

* Add quoting advice for PowerShell CLI options

* Fix --config typo

Co-authored-by: Jennifer Shehane <[email protected]>

---------

Co-authored-by: Jennifer Shehane <[email protected]>

* Bump Cypress Docker versions in examples to Node.js 22.15.0 LTS (#6161)

---------

Co-authored-by: Mike McCready <[email protected]>
Co-authored-by: danjohansenconsulting <[email protected]>
Co-authored-by: Cacie Prins <[email protected]>
Co-authored-by: Jennifer Shehane <[email protected]>
Co-authored-by: Matthew Sbar <[email protected]>
Co-authored-by: Tim Rayers <[email protected]>
Co-authored-by: Emily Wisniewski (Rohrbough) <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Tyler Biethman <[email protected]>
Co-authored-by: Matt Schile <[email protected]>
Co-authored-by: Jennifer Shehane <[email protected]>
chore: merge `develop` into `release/15.0.0`
…eprocessor` built-ins removal (#6192)

* chore: add migration guide if needing webpack built-ins

* Update docs/app/references/migration-guide.mdx

Co-authored-by: Jennifer Shehane <[email protected]>

* run linter

---------

Co-authored-by: Jennifer Shehane <[email protected]>
@jennifer-shehane jennifer-shehane marked this pull request as ready for review June 18, 2025 20:42

### Webpack `4` is no longer supported

Cypress is no longer supporting Webpack `4` as it is no longer maintained by the core Webpack team and Webpack `5` has been available since Q4 2020. This includes Webpack `4` support for:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Cypress is no longer supporting Webpack `4` as it is no longer maintained by the core Webpack team and Webpack `5` has been available since Q4 2020. This includes Webpack `4` support for:
Cypress is no longer supporting Webpack `4` as it is no longer maintained by the core Webpack team and Webpack `5` has been available since Q4 2020. This includes dropping Webpack `4` support for:

Cypress is no longer supporting Webpack `4` as it is no longer maintained by the core Webpack team and Webpack `5` has been available since Q4 2020. This includes Webpack `4` support for:

- `@cypress/webpack-dev-server` for component testing. This use case is most common and will require an update to Webpack `5`.
- `@cypress/webpack-dev-server` also no longer supports [Webpack Dev Server v4](https://github.com/webpack/webpack-dev-server/tree/v4.15.2). We shipped [Webpack Dev Server v5](https://github.com/webpack/webpack-dev-server/tree/v5.2.1) as the default in Cypress 14 with `webpack-dev-server@4` being an option.
Copy link
Member

Choose a reason for hiding this comment

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

with webpack-dev-server@4 being an option.

this is confusing - this should no longer be an option right?

})
```

Note that this package version is deprecated and no longer supported by Cypress and is intended as a workaround until you can migrate to Webpack `5`. More information on how to configure the dev server can be found in the [Cypress Webpack Dev Server documentation](https://github.com/cypress-io/cypress/blob/@cypress/webpack-dev-server-v4.0.2/npm/webpack-dev-server/README.md) and [Custom Dev Server documentation](/app/component-testing/component-framework-configuration#Custom-Dev-Server).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Note that this package version is deprecated and no longer supported by Cypress and is intended as a workaround until you can migrate to Webpack `5`. More information on how to configure the dev server can be found in the [Cypress Webpack Dev Server documentation](https://github.com/cypress-io/cypress/blob/@cypress/webpack-dev-server-v4.0.2/npm/webpack-dev-server/README.md) and [Custom Dev Server documentation](/app/component-testing/component-framework-configuration#Custom-Dev-Server).
Note that this package version is deprecated and no longer supported by Cypress and is intended as a workaround until you can migrate to Webpack `5`. More information on how to configure the dev server `v4 `can be found in the [Cypress Webpack Dev Server documentation](https://github.com/cypress-io/cypress/blob/@cypress/webpack-dev-server-v4.0.2/npm/webpack-dev-server/README.md) and [Custom Dev Server documentation](/app/component-testing/component-framework-configuration#Custom-Dev-Server).


##### End-to-End Testing

If you haven't been able to migrate away from Webpack `4`, need custom end-to-end spec file preprocessing, are already using `@cypress/webpack-preprocessor` as a standalone package, and still need to be able to run your end-to-end tests with Webpack `4`, you can install the following package independently:
Copy link
Member

Choose a reason for hiding this comment

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

to stay on webpack v4, is does this mean you need need custom end-to-end spec file preprocessing or how does someone know they need it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants