v4.2.0

This minor release adds support for passing along Cypress supported options to cy.task via all happo calls. For example, you can pass log: false to suppress the Happo commands from the Cypress log panel:

cy.get('body').happoScreenshot({ component: 'Login page', log: false });

v4.1.3

As with v4.1.2, this patch release addresses an issue with duplicate Happo snapshots showing up when a spec is retried. When updating to this version, make sure to also update happo-e2e to v 2.4.0 or later.

v4.1.2

This patch release has a fix for handling retried test cases in Cypress v13.

v4.1.1

No code changes in this patch release. We've excluded a set of files and folders from the resulting npm package to make it smaller.

v4.1.0

This release adds support for a new option for happoScreenshot: includeAllElements: true. This option can be used if you need the screenshot to include multiple elements that don't have a common ancestor/parent elements. Here's an example where all elements with the class name "portal" is included in a screenshot:

cy.get('.portal').happoScreenshot({ component: 'All portals', includeAllElements: true });

If you leave out the includeAllElements option, only the first matching element will be included in the screenshot. This is the default behavior.

To use this new option, you need to be on happo-e2e@2.2.0 or later: https://github.com/happo/happo-e2e/releases/tag/v2.2.0

v4.0.0

This release moves happo-e2e from dependencies to peerDependencies. This means you'll have to install happo-e2e separately from happo-cypress. Most people already have already done this because the docs mention installing both packages separately, so even though this is a breaking change it will have little impact for most people.

v3.0.1

This release bumps usage of happo-e2e to v1.0.3. It has a bug fix for dynamic images, e.g. ones loaded via next/image.

v3.0.0

Breaking changes:

• The happo-cypress wrapper has been replaced by happo-e2e

In this release, the meaty bits have been extracted into a happo-e2e library, to allow for other end-to-end test frameworks (like Playwright) to use the same happo core. The main thing that affects users is that the happo-cypress wrapper has now been replaced by happo-e2e:

First, install happo-e2e:

npm install --save-dev happo-e2e

Then, replace happo-cypress -- with happo-e2e, e.g.

npx happo-e2e -- npx cypress run

v2.0.0

Version 2 fixes a bug with spec files that were automatically retried. In previous versions, Happo would duplicate screenshots made in retried attempts, leading to snapshots like "Button-default-1", "Button-default-2", etc. To fix this, we had to rewire how the happo-cypress plugin is registered/initialized. Before, this was enough:

// version 1.x
on('task', happoTask);

After updating to v2, you'll have to initialize the plugin slightly different:

// version 2
happoTask.register(on);

v1.24.2

Fix resolving current sha from workflow_dispatch type builds in GitHub Actions.