Run Cypress E2E tests
A GitHub Action for running Cypress end-to-end and component tests in CI workflows with built-in dependency installation and caching.
What is Run Cypress E2E tests?
cypress-io/github-action is a GitHub Action that runs Cypress end-to-end and component tests in CI/CD pipelines. It automates dependency installation, caching, and test execution, reducing the boilerplate needed to integrate Cypress with GitHub Actions. The action supports recording to Cypress Cloud, parallel test runs, and multiple browsers.
Developers and teams using Cypress for testing who want to integrate their test suites into GitHub Actions workflows with minimal configuration.
It simplifies CI setup by handling Cypress-specific complexities like binary caching, dependency management, and server coordination in a single action, saving time and ensuring consistent test execution across environments.
Overview
GitHub Action for running Cypress end-to-end & component tests
Use Cases
Best For
- Running Cypress end-to-end tests in GitHub Actions CI pipelines
- Integrating Cypress component tests into continuous integration workflows
- Setting up parallel test execution with Cypress Cloud recording
- Testing applications across multiple browsers in CI
- Reducing CI configuration boilerplate for Cypress projects
- Coordinating local server startup with Cypress test execution
Not Ideal For
- Projects using CI/CD platforms other than GitHub Actions, such as GitLab CI or Jenkins
- Teams that prefer writing custom GitHub Actions workflows from scratch for granular control over each step
- Testing frameworks outside the Cypress ecosystem, like Playwright or Selenium WebDriver
- Simple projects where basic shell commands suffice and advanced caching or server coordination is unnecessary
Pros & Cons
Pros
The action reduces boilerplate by handling dependency installation, caching, and test execution in a single step, as shown in the basic example using just `uses: cypress-io/github-action@v7`.
It caches Cypress binaries and dependencies to minimize download times and bandwidth, explicitly mentioned in the caching section to speed up CI runs.
Supports running tests in Chrome, Firefox, Edge, and Electron, including Chrome for Testing, enabling cross-browser validation in CI without extra setup.
Seamlessly integrates with Cypress Cloud for recording results, parallel execution, and smart orchestration, enhancing test management with features like auto-cancellation.
Cons
The action requires workarounds for Yarn Modern with Plug'n'Play and doesn't fully support pnpm workspaces, as admitted in the README with examples using custom commands and separate steps.
For monorepos or projects with multiple servers, configuration can become intricate, needing careful handling of parameters like `working-directory` and `start`, which may confuse new users.
Advanced features like parallel execution and smart orchestration are tightly coupled with Cypress Cloud, a paid service, limiting flexibility for teams not using it or preferring other tools.
Frequently Asked Questions
Related Projects
Run Unity testsRun tests for any Unity project
Run Tests through Puppeteer, the Headless Chrome Node APIA GitHub Action / Docker image for Puppeteer, the Headless Chrome Node API
Run Julia testsThis action runs the tests in a Julia package.
Test Ansible roles with MoleculeTest Ansible roles using Molecule
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.