-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add browser support section #6237
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
Conversation
👷 Deploy request for cypress-docs pending review.Visit the deploys page to approve it
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Feels a bit odd to add to the install. As the install is not where this requirement is needed. It's at the launching browsers step that it would fail.
I would say this section certainly needs updating to include the Firefox 141 CDP no longer working. I don't think that env var would work anymore. https://docs.cypress.io/app/references/launching-browsers#Webdriver-BiDi-and-CDP-Deprecation
It's always hard to figure out where to put 'We don't support this anymore' info because you want to stay current. 🤔
It felt right to add it to this page, because there are two major sections to Get Started > Install Cypress
and the browser information belongs to "System requirements". Similar to the section Linux Prerequisites, you can install Cypress without the Linux prerequisites (I tested this): you just can't run Cypress without them installed. So, if you don't have the right browsers installed, you won't be able to run against them. Merging this PR would mean that compatibility information is all on one page, for easier reference.
Yes, this is difficult, because the Cypress documentation is only supposed to cover the latest version, apart from the Changelog and Migration Guide and the history tables at the bottom of some pages. Perhaps just defer trying to address this point until after Cypress 15 is released? Firefox <=134, which would need the environment variable, no longer falls into the category of 3 latest versions supported. A short note would still be helpful to confirm the need to update / upgrade though. |
The Cypress 15 beta docs should probably be discussed elsewhere, even though I brought up the topic here. This PR is for Cypress 14 as the current latest version. But just to round off the discussion:
|
Situation
Firefox
141.0
and above is not compatible with versions of Cypress below 14.1.0 and this is not specifically mentioned on https://docs.cypress.io/ (see cypress-io/cypress#32148).The Get Started > Install Cypress > System requirements section lists only base system requirements without mentioning browsers. For browser information, readers have to find and consult with the page References > Launching Browsers where the Firefox version restriction is however not mentioned.
The related section References > Launching Browsers > Browsers > Firefox Browsers > Webdriver BiDi and CDP Deprecation is planned for removal in Cypress 15.
Change
Add a "Browsers" section to the page Get Started > Install Cypress > System requirements section.
Suggestion
Review the plans to remove the section References > Launching Browsers > Browsers > Firefox Browsers > Webdriver BiDi and CDP Deprecation in Cypress 15 and consider reworking it based on the current situation. Perhaps retitle to "Webdriver CDP to BiDi Migration" given that CDP is no longer just deprecated, but removed entirely?
Reference