Skip to content
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

.readFile() is now a query #5017

Merged
merged 4 commits into from
Feb 1, 2023
Merged

Conversation

BlueWinds
Copy link
Contributor

Matching code PR: cypress-io/cypress#25595

.readFile() will be a query in Cypress 13. This should have minimal impact on most users, but is a breaking change for anyone who was overwritting the command.

@vercel
Copy link

vercel bot commented Jan 30, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
cypress-documentation ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Jan 31, 2023 at 5:55PM (UTC)

existed, but would _not_ re-read it from disk if the file didn't have the
requested property or the contents didn't match.

#### `.readFile()` can no longer be overwritten with `Cypress.Commands.overwrite()`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

My hope is to have cypress-io/cypress#25078 done before we release Cy13, which would necessitate rewriting this part of the migration guide (to say "actually you can totally still do it, here's how").

@BlueWinds BlueWinds merged commit 6d03547 into release-13.0.0 Feb 1, 2023
@BlueWinds BlueWinds deleted the issue-25134-readfile-as-query branch February 1, 2023 19:26
mjhenkes added a commit that referenced this pull request Jun 20, 2023
* .readFile() is now a query

* Add section on new .readFile() superpowers

* Fix page slug for readFile

* Prettier run

Co-authored-by: Blue F <blue@everblue.info>
AtofStryker added a commit that referenced this pull request Jul 12, 2023
* .readFile() is now a query (#5017)

* .readFile() is now a query

* Add section on new .readFile() superpowers

* Fix page slug for readFile

* Prettier run

* Update guides to better support users in Cy 13, where assertions are now commands

* Review updates

* Apply suggestions from code review

Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>

* Partial review feedback (more to come)

* Review updates

* Prettier run

* fix: update retry ability guide and migration guide now that should() and and() will not be queries in v13. see cypress-io/cypress#25738

* chore: correct number of queries in example

* revert: images changes due to should() and and() being queries, which is no longer applicable due to cypress-io/cypress#25738

* chore: lint guides

---------

Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>
Co-authored-by: Bill Glesias <bglesias@gmail.com>
jaffrepaul added a commit that referenced this pull request Aug 29, 2023
* BREAKING: update documentation by setting default video: false for v13.0.0 (#5300)

* BREAKING: update documentation by setting default video: false

* Update docs/guides/overview/why-cypress.mdx

Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>

* Update docs/guides/end-to-end-testing/migration/protractor-to-cypress.mdx

Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>

* Update docs/guides/continuous-integration/introduction.mdx

Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>

* Update docs/guides/guides/screenshots-and-videos.mdx

Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>

* chore: re-order video bits

* Update docs/guides/end-to-end-testing/migration/protractor-to-cypress.mdx

* chore: linting

---------

Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>

* breaking: update documentation by setting videoCompression: false (#5301)

* BREAKING: update documentation by setting default video: false

* BREAKING: update documentation by setting videoCompression: false

* Update docs/guides/guides/screenshots-and-videos.mdx

Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com>

* apply suggestion from code review

* chore: attempt to rework the video encoding section

* Update docs/guides/guides/screenshots-and-videos.mdx

Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>

* chore: address comments in code review

* chore: update video encoding guide to flow a bit more evenly

---------

Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com>
Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>

* BREAKING: remove the videoUploadOnPasses configuration option (#5306)

* BREAKING: remove the videoUploadOnPasses configuration option

* chore: add history entry of removed videoUploadOnPasses config option

* .readFile() is now a query (#5017) (#5316)

* .readFile() is now a query

* Add section on new .readFile() superpowers

* Fix page slug for readFile

* Prettier run

Co-authored-by: Blue F <blue@everblue.info>

* Update guides for Cy 13, where assertions are now commands (#5081)

* .readFile() is now a query (#5017)

* .readFile() is now a query

* Add section on new .readFile() superpowers

* Fix page slug for readFile

* Prettier run

* Update guides to better support users in Cy 13, where assertions are now commands

* Review updates

* Apply suggestions from code review

Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>

* Partial review feedback (more to come)

* Review updates

* Prettier run

* fix: update retry ability guide and migration guide now that should() and and() will not be queries in v13. see cypress-io/cypress#25738

* chore: correct number of queries in example

* revert: images changes due to should() and and() being queries, which is no longer applicable due to cypress-io/cypress#25738

* chore: lint guides

---------

Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>
Co-authored-by: Bill Glesias <bglesias@gmail.com>

* Apply suggestions from code review

Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>

* Remove nodeVersion documentation (#5318)

* Remove reference to 'nodeVersion'

* added history, removed changes to legacy

* docs: v13 video and TR migration info (#5383)

* added video config migration info

* added tr migration info

* PR feedback

* PR feedback

* PR feedback

* Apply suggestions from code review

Co-authored-by: Bill Glesias <bglesias@gmail.com>

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

Co-authored-by: Jennifer Shehane <jennifer@cypress.io>

---------

Co-authored-by: Bill Glesias <bglesias@gmail.com>
Co-authored-by: Jennifer Shehane <jennifer@cypress.io>

* Update results for module API and after:spec handler (#5379)

* docs: adding documentation for runner-ui cli flags (#5424)

* docs: test replay docs (#5349)

* sidebar content shuffle

* main feature content & link updates

* add screenshots

* add url to vpn whitelist

* add TR banner

* add & reorder faq

* build test replay partial

* add TR partial to related content

* add TR link to related "see more" sections

* content tweaks

* include TR content in body copy

* add troubleshooting

* remove old images

* add PR feedback

* add command log notes

* remove dead link

* update images

* replace runs page screenshots

* Apply suggestions from code review

Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
Co-authored-by: Bill Glesias <bglesias@gmail.com>

Co-authored-by: Jennifer Shehane <jennifer@cypress.io>

* add more faqs

* restore missing partial export

* fix links

* swap in screenshot of new network panel

* Apply suggestions from code review

Co-authored-by: Bill Glesias <bglesias@gmail.com>

* fix command line merge issue

* lint

* Update docs/guides/cloud/debugging/recorded-runs.mdx

Co-authored-by: Bill Glesias <bglesias@gmail.com>

* Apply suggestions from code review

Co-authored-by: Bill Glesias <bglesias@gmail.com>

---------

Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
Co-authored-by: Bill Glesias <bglesias@gmail.com>

* Fix JavaScript caps

* Fix caps of JavaScript

* Fix typo

* Write a document around Cloud data storage and controls (#5425)

Co-authored-by: Paul Jaffre <jaffrepaul@gmail.com>
Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>

* add changelog, remove node 16 support, and update docker image refere… (#5434)

* add changelog, remove node 16 support, and update docker image reference to be on at least node 18

* Update docs/guides/references/changelog.mdx

* docs: minor v13 updates (#5438)

* match data callout with data storage page

* remove mention from artifacts panel

* remove submitting feature requests callout

* build & insert cloud free plan partial

* docs: update v13 content urls (#5428)

* update content urls

* add todo

* replace v13 changelog urls

* docs: v13 changelog summary (#5441)

* changelog summary

* Update docs/guides/references/changelog.mdx

Co-authored-by: Jennifer Shehane <jennifer@cypress.io>

* tweak verbaige & lint

---------

Co-authored-by: Jennifer Shehane <jennifer@cypress.io>

* Apply suggestions from code review

Co-authored-by: Bill Glesias <bglesias@gmail.com>

* lint

* Update docs/faq/questions/cloud-faq.mdx

Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>

* include TR note in cypress screenshot api options (#5445)

* docs: additional test replay content (#5447)

* add TR cost faq

* add centos troubleshooting

* sync up changelog

* Update _cloud_free_plan.mdx

minor text update

---------

Co-authored-by: Bill Glesias <bglesias@gmail.com>
Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>
Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com>
Co-authored-by: Blue F <blue@everblue.info>
Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
Co-authored-by: Paul Jaffre <jaffrepaul@gmail.com>
Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
Co-authored-by: Matt Schile <mschile@cypress.io>
Co-authored-by: Chris Breiding <chrisbreiding@gmail.com>
Co-authored-by: Paul Jaffre <paul@cypress.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants