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

File download updates #3472

Merged
merged 6 commits into from
Jan 19, 2021
Merged

File download updates #3472

merged 6 commits into from
Jan 19, 2021

Conversation

jennifer-shehane
Copy link
Member

@jennifer-shehane jennifer-shehane commented Jan 8, 2021

Initially addressing docs for cypress-io/cypress#14431 but I think we can leave this open to see if more work will merge in for 6.3.0, to further update the download docs.

What to update?

  • I added a new section to 'writing and organizing tests' explaining 'Asset files'.
  • I wonder if the 'Screenshots and Videos' page should be repurposed to 'Asset Files' doc? I've always leaned against doing that because I felt people would search and understand screenshots/videos more easily.

Some other sections of docs that require updating:

@chrisbreiding
Copy link
Contributor

Change download directory: docs.cypress.io/api/plugins/browser-launch-api.html#Change-download-directory @chrisbreiding is this still relevant? Will this example work?

Updated this to be about adding a unique mime type, as changing the downloads directory can now be done with the downloadsFolder option.

FAQ about file download: docs.cypress.io/faq/questions/using-cypress-faq.html#Is-there-a-way-to-test-that-a-file-got-downloaded-I-want-to-test-that-a-button-click-triggers-a-download

I'm not sure about this one. All the ways listed to test downloads are still relevant and valid. For example, a user might still want to test an href since that will be faster than downloading the file and they might not care about the contents.

If anything, maybe we can move up the part about downloading the file since it has better support now. We should still point users to the recipe, since it shows them how to then test the downloaded file itself.

@chrisbreiding chrisbreiding marked this pull request as ready for review January 12, 2021 14:23
@jennifer-shehane jennifer-shehane changed the base branch from develop to 6.3.0-release January 19, 2021 05:43
@jennifer-shehane jennifer-shehane merged commit 08d6cd1 into 6.3.0-release Jan 19, 2021
@jennifer-shehane jennifer-shehane mentioned this pull request Jan 19, 2021
4 tasks
@matthamil matthamil deleted the file-download-updates branch April 14, 2021 20:09
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