chore: deprecate .end() command#6431
Merged
mschile merged 6 commits intorelease/15.15.0from May 1, 2026
Merged
Conversation
Marks the `.end()` command as deprecated in 15.15.0 and recommends starting a new `cy` chain as the migration path. Adds the deprecated sidebar label, a caution banner with before/after examples on the command page, and a deprecated badge in the API table of contents.
Fix prettier formatting on `docs/api/commands/end.mdx` and `docs/api/table-of-contents.mdx`. Also adjusts the deprecation banner copy on `end.mdx` to match the wording used elsewhere in the file.
Aligns the sidebar deprecation tag with the yellow/orange `caution` badge used in inline content so deprecation indicators are visually consistent across the sidebar and page content. Affects every page with `deprecated_label: true`.
This reverts commit 01175c5.
Aligns the Cypress.env row with the deprecated badge placement now used for .end() — the badge sits next to the property name rather than in front of the description.
cypress-documentation
 |
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress-documentation
|
| Branch Review |
mschile/sleepy-shtern-33f81a
|
| Run status |
|
| Run duration | 05m 55s |
| Commit |
|
| Committer | Matthew Schile |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
 |
0
|
 |
0
|
 |
0
|
 |
0
|
 |
322
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
47.51%
|
|
|---|---|
|
|
337
|
|
|
3
|
Accessibility
96.89%
|
|
|---|---|
|
|
1 critical
3 serious
4 moderate
1 minor
|
|
|
37
|
AtofStryker
approved these changes
May 1, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
.end()command as deprecated in Cypress15.15.0.deprecatedsidebar label on the command's doc page and a:::cautionbanner with before/after examples that recommend starting a newcychain instead.deprecatedbadge next to.end()in the API table of contents..end()reference from the introduction-to-cypress chaining example.Files changed
docs/api/commands/end.mdx— frontmatter + deprecation banner; updated examples to usecy.get(...).docs/api/table-of-contents.mdx— added<Badge type="caution">deprecated</Badge>next to.end().docs/app/core-concepts/introduction-to-cypress.mdx— dropped the trailing.end()reference in thecy.clearCookies()chaining note.Note: I think we need to add a yellow color for the
deprecated_labelwhich currently shows as red. However, this matches what ourCypress.envdeprecation currently looks like.Test plan
end..end()page renders the caution banner with Before/After code examples..end()row..end()reference.Note
Low Risk
Low risk documentation-only change that adds deprecation messaging and adjusts examples; no runtime behavior is modified.
Overview
Marks the
cy.end()/.end()command docs as deprecated (Cypress15.15.0) by adding a deprecation banner, sidebar deprecation label, and updated guidance to start a fresh command chain fromcy.Updates the API table of contents to show a deprecated badge for
.end(), and removes the.end()mention from the chaining explanation in the Introduction guide while tweaking related examples to usecy.get(...)selectors.Reviewed by Cursor Bugbot for commit 313e54d. Bugbot is set up for automated code reviews on this repo. Configure here.