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

9.3.0 Release #4304

Merged
merged 17 commits into from
Jan 18, 2022
Merged

9.3.0 Release #4304

merged 17 commits into from
Jan 18, 2022

Conversation

jennifer-shehane
Copy link
Member

@jennifer-shehane jennifer-shehane commented Jan 5, 2022

@vercel
Copy link

vercel bot commented Jan 5, 2022

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/cypress-io/cypress-documentation/GAK8WA6nptVw3grFKi6L134obSuq
✅ Preview: https://cypress-documentation-git-930-release-cypress-io.vercel.app

BlueWinds and others added 2 commits January 14, 2022 16:00
This is a manual recreation of #4241 for 9.3.0 release
Add docs for .selectFile() and Cypress.Buffer
Copy link
Member Author

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

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

@emilyrohrbough I didn't have time to fully review.

Comment on lines 5 to 10
**News:**

- We've
[written a blog post](https://cypress.io/blog/2022/01/18/uploading-files-with-selectfile/)
about the new Cypress command, `cy.selectFile()` introduced in `9.3.0`.

Copy link
Member Author

@jennifer-shehane jennifer-shehane Jan 18, 2022

Choose a reason for hiding this comment

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

I would put the blog post within the feature and remove this "news" section - this isn't conventional. It would be nice to have marketing's help on crafting how to word these in the future.

Copy link
Member

Choose a reason for hiding this comment

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

@jennifer-shehane Sounds good. I pulled this section from a different changelog

Comment on lines 13 to 22
- Added a new Cypress command, called `cy.selectFile()`, which provides the
ability to submit a file to file input elements. This command can also
simulate a user drag-dropping files over the document. The API is similar to
`cypress-file-upload`, and we have provided a migration guide for previous
users of that plugin. For full details, see
[our blog post](https://cypress.io/blog/2022/01/18/uploading-files-with-selectfile/)
and the
[cy.selectFile() documentation](https://docs.cypress.io/api/commands/selectfile).
Fixes [#19524](https://github.com/cypress-io/cypress/issues/19524) and
[#170](https://github.com/cypress-io/cypress/issues/170).
Copy link
Member Author

Choose a reason for hiding this comment

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

Let's match the wording from the selectFile doc itself.

Commands that are chained (child commands) do not have cy. prefixed.

Link to the migration guide where we mentioned the migration guide.

Suggested change
- Added a new Cypress command, called `cy.selectFile()`, which provides the
ability to submit a file to file input elements. This command can also
simulate a user drag-dropping files over the document. The API is similar to
`cypress-file-upload`, and we have provided a migration guide for previous
users of that plugin. For full details, see
[our blog post](https://cypress.io/blog/2022/01/18/uploading-files-with-selectfile/)
and the
[cy.selectFile() documentation](https://docs.cypress.io/api/commands/selectfile).
Fixes [#19524](https://github.com/cypress-io/cypress/issues/19524) and
[#170](https://github.com/cypress-io/cypress/issues/170).
- You can now selects a file or files in an HTML5 input element or simulates dragging a file
or files into the browser using `.selectFile()`. The API is similar to
`cypress-file-upload` and we have provided a migration guide for previous
users of that plugin. For full details, see
[our blog post](https://cypress.io/blog/2022/01/18/uploading-files-with-selectfile/)
and the
[.selectFile() documentation](https://docs.cypress.io/api/commands/selectfile).
Fixes [#19524](https://github.com/cypress-io/cypress/issues/19524) and
[#170](https://github.com/cypress-io/cypress/issues/170).

Copy link
Member Author

Choose a reason for hiding this comment

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

Also these docs links need to be updated to internal links.

[cy.selectFile() documentation](https://docs.cypress.io/api/commands/selectfile).
Fixes [#19524](https://github.com/cypress-io/cypress/issues/19524) and
[#170](https://github.com/cypress-io/cypress/issues/170).
- Exposed the `Buffer` polyfill, as `Cypress.Buffer`, to enable working with
Copy link
Member Author

Choose a reason for hiding this comment

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

Link to the new Cypress.Buffer doc here.

Comment on lines 13 to 22
- Added a new Cypress command, called `cy.selectFile()`, which provides the
ability to submit a file to file input elements. This command can also
simulate a user drag-dropping files over the document. The API is similar to
`cypress-file-upload`, and we have provided a migration guide for previous
users of that plugin. For full details, see
[our blog post](https://cypress.io/blog/2022/01/18/uploading-files-with-selectfile/)
and the
[cy.selectFile() documentation](https://docs.cypress.io/api/commands/selectfile).
Fixes [#19524](https://github.com/cypress-io/cypress/issues/19524) and
[#170](https://github.com/cypress-io/cypress/issues/170).
Copy link
Member Author

Choose a reason for hiding this comment

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

Also these docs links need to be updated to internal links.

Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
[@abramenal](https://github.com/abramenal) and contributors to the
[cypress-file-upload](https://github.com/abramenal/cypress-file-upload#contributors)
repository.

Copy link
Member

Choose a reason for hiding this comment

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

@cowboy / @BlueWinds Was there intentions of linking to the cypress-file-uploaded migration guide here?

Copy link
Contributor

Choose a reason for hiding this comment

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

I wasn't planning on it. IMO the docs are a bit more 'permanent', while the migration guide is intended to fall off in visibility (get buried as we release more versions).

I'm not against adding a link if people feel it would be helpful, but not sure it's necessary here (since there are other links to it scattered around).

Copy link
Contributor

Choose a reason for hiding this comment

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

I'll have to look and see. It shouldn't hold up the release, however. We can always add it afterwards.

- Fixed an issue where the `--spec` CLI parameter was not working properly when
passing multiple glob patterns that are separated by commas. Fixes
[#16102](https://github.com/cypress-io/cypress/issues/16102).

Copy link
Contributor

@tbiethman tbiethman Jan 18, 2022

Choose a reason for hiding this comment

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

cypress-io/cypress#19559 was missing a release

Suggested change
- CYPRESS_VERIFY_TIMEOUT can also be set in package.json and .npmrc. Fixes [#19559](https://github.com/cypress-io/cypress/issues/19559).

Copy link
Member

Choose a reason for hiding this comment

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

updated: d33b75a (#4304)

Co-authored-by: Paul Jaffre <jaffrepaul@gmail.com>
@emilyrohrbough emilyrohrbough marked this pull request as ready for review January 18, 2022 21:08
cowboy
cowboy previously requested changes Jan 18, 2022
Copy link
Contributor

@cowboy cowboy left a comment

Choose a reason for hiding this comment

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

One minor nit, other than that LGTM

Co-authored-by: Ben Alman <cowboy@rj3.net>
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.

7 participants