-
Notifications
You must be signed in to change notification settings - Fork 1.1k
chore: update angular documentation with supported versions from Cypress 14 #5983
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
Merged
AtofStryker
merged 2 commits into
release/14.0.0
from
chore/update_angular_documentation_versioning
Nov 6, 2024
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -108,6 +108,46 @@ it('renders', () => { | |
| }) | ||
| ``` | ||
|
|
||
| ### Angular versions under `17.2.0` are no longer supported in Component Testing. | ||
|
|
||
| With [LTS ending](https://angular.dev/reference/releases#actively-supported-versions) for Angular 16, the minimum required Angular version for component testing is now `17.2.0` in order to support [signals](/app/component-testing/angular/examples#Signals) as a first class citizen. | ||
|
|
||
| If for any reason an older version of Angular must be used, please download [`@cypress/angular`](https://www.npmjs.com/package/@cypress/angular) `2.x` from `npm`. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍🏻 |
||
|
|
||
| ```sh | ||
| npm install --save-dev @cypress/angular@2 | ||
| ``` | ||
|
|
||
| Then, import the `mount` from from this package in place of `cypress/angular`. | ||
AtofStryker marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```ts | ||
| import { mount } from `cypress/angular` | ||
| ``` | ||
|
|
||
| to | ||
|
|
||
| ```ts | ||
| import { mount } from `@cypress/angular` | ||
| ``` | ||
|
|
||
| This version of `@cypress/angular` is not actively supported and is only recommended as a workaround until you are able to upgrade. | ||
|
|
||
| ### `cypress/angular` now supports signals. The `cypress/angular-signals` test harness has been removed from the binary. | ||
|
|
||
| Now that the minimum version of Angular supported for Component Testing is `17.2.0`, Cypress is able to merge the `cypress/angular-signals` test harness into the main `cypress/angular` test harness. Because of this, the `@cypress/angular-signals` harness is deprecated and no longer shipped with the binary. Support has been moved to `@cypress/angular`. | ||
AtofStryker marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| To migrate, just change the test harness from `cypress/angular-signals` to `cypress/angular`! | ||
AtofStryker marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```ts | ||
| import { mount } from `cypress/angular-signals` | ||
| ``` | ||
|
|
||
| to | ||
|
|
||
| ```ts | ||
| import { mount } from `cypress/angular` | ||
| ``` | ||
|
|
||
| ## Migrating to Cypress 13.0 | ||
|
|
||
| This guide details the changes and how to change your code to migrate to Cypress | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.