Skip to content

Commit

Permalink
Write 5.0 changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
jennifer-shehane committed Jun 30, 2020
1 parent cf66d9d commit dca4c4e
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions source/_changelogs/5.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,52 @@

**Summary:**

Cypress now includes support for test retries! Similar to how Cypress will retry assertions when they fail, test retries will allow you to automatically retry a failed test prior to marking it as failed. Read our new guide on Test Retries for more details.

**Breaking Changes:**

**{% fa fa-exclamation-triangle red %} Please read our {% url "Migration Guide" migration-guide %} which explains the changes in more detail and how to change your code to migrate to Cypress 5.0.**

- Test retries are on by default when running via {% url "`cypress run`" command-line#cypress-run %}. This means that tests will automatically be re-run up to 2 additional times (for a total of 3 attempts) before potentially being marked as a failed test. Additionally, the {% url "`cypress-plugin-retries`" https://github.com/Bkucera/cypress-plugin-retries %} plugin has been deprecated. Addresses {% issue 1313 %}.
- The {% url "`Cypress.Cookies.defaults()`" cookies %} `whitelist` option has been renamed to `preserve` to more closely reflect its behavior. Addressed in {% issue 7782 %}.
- The `blacklistHosts` configuration has been renamed to {% url "`blockHosts`" configuration#Notes %} to more closely reflect its behavior. Addressed in {% issue 7622 %}.
- The {% url "`cy.server()`" server %} `whitelist` option has been renamed to `ignore` to more closely reflect its behavior. Addresses {% issue 6642 %}.
- `libgbm-dev` is now a requirement to run Cypress on Linux. Addressed in {% PR 7791 %}.
- Values yielded by {% url "`cy.setCookie()`" setcookie %}, {% url "`cy.getCookie()`" getcookie %}, and {% url "`cy.getCookies()`" getcookies %} will now contain the `sameSite` property if specified. Addresses {% issue 6892 %}.
- The `experimentalGetCookiesSameSite` configuration flag has been removed, since this behavior is now the default. Addresses {% issue 6892 %}.
- The return type of the {% url "`Cypress.Blob`" blob %} methods `arrayBufferToBlob`, `base64StringToBlob`, `binaryStringToBlob`, and `dataURLToBlob` have changed from `Promise<Blob>` to `Blob`. Addresses {% issue 6001 %}.
- We removed the default `esModuleInterop: true` option when using TypeScript so that it can now be overridden. Addresses {% issue 7575 %}.
- Cypress now requires TypeScript 3.4+. Addressed in {% issue 7856 %}.
- Installing Cypress on your system now requires Node.js 10+. Addresses {% issue 6574 %}.

**Features:**

- There's a new `retries` configuration option to configure the number of times to retry a failing test. Addresses {% issue 1313 %}.

**Bugfixes:**

- Cypress will now properly run on Firefox versions >= 75. Addressed in {% PR 7791 %}.
- The Developer Tools menu will now always display in Electron when switching focus from Specs to the Test Runner. Addressed in {% PR 7791 %}.
- We now emit the pass event from Mocha after all hooks have run. Addresses {% issue 7730 %}.

**Documentation Changes:**

- We have a new guide on Test Retries.
- Our {% url "Migration Guide" migration-guide %} has a new section for 5.0 migration.

**Misc:**

- The type for the `Window` object returned from {% url "`cy.window()`" window %} is now correct. Addresses {% issue 7856 %}.
- The type definition for Cypress's `ApplicationWindow` can now be extended. Addresses {% issue 7856 %}.

**Dependency Updates**

- Upgraded Chrome browser version used during cypress run and when selecting Electron browser in cypress open from `80` to `83`. Addressed in {% PR 7791 %}.
- Upgraded bundled Node.js version from `12.8.1` to `12.14.1`. Addressed in {% PR 7791 %}.
- Upgraded `electron` from `8.3.1` to `9.0.5`. Addressed in {% PR 7791 %}.
- Upgraded `chalk` from `2.4.2` to `4.1.0`. Addressed in {% PR 7650 %}.
- Upgraded `cli-table3` from `0.5.1` to `0.6.0`. Addressed in {% PR 7650 %}.
- Upgraded `execa` from `1.0.0` to `4.0.2`. Addressed in {% PR 7650 %}.
- Upgraded `log-symbols` from `3.0.0` to `4.0.0`. Addressed in {% PR 7650 %}.
- Upgraded `tmp` from `0.1.0` to `0.2.1`. Addressed in {% PR 7650 %}.
- Upgraded `fs-extra` from `8.1.0` to `9.0.1`. Addressed in {% PR 7650 %}.

0 comments on commit dca4c4e

Please sign in to comment.