Tutorial - Basic Setup

After completing this tutorial, you will have a working setup for capturing screenshots with Cypress and uploading them to the Webshot Archive API. This section of the tutorial will guide you through: setting up your Webshot Archive account, setting up cypress.io to capture screenshots, running the cypress.io tests with the Github Action, validating the screenshots on the Github PR, and running the Github Action on push to the main branch.

📄️ Github Action Credentials

At the end of this tutorial, you will have a working setup for capturing screenshots with Cypress and uploading them to the Webshot Archive API and showing image diffs on a Github PR.

📄️ Uploading Screenshots from e2e tests

After setting up the API User (Create Client Credentials), Github Actions can capture screenshots with Cypress, Playwright, or other e2e testing tools. The Webshot Archive Github Action will upload the screenshots to the Webshot Archive API and comment on the Pull Request showing the image and diffs (if any).