cypress-io/github-action [![Action status][ci-badge]][ci-workflow] [![cypress][cloud-badge]][cloud-project] [![renovate-app badge][renovate-badge]][renovate-bot]

Cypress based cypress-io/github-action runs End-to-End or Component tests in GitHub Actions Continuous Integration (CI) workflows, optionally recording to Cypress Cloud

Introduction

In addition to running Cypress tests, the action includes dependency installation, caching and more:

The following examples demonstrate the actions' functions.

Examples

• End-to-End testing
• Component testing
• Select action version
• Run tests in a given browser
• using Chrome
• using Chrome for Testing
• using Firefox
• using Edge
• using headed mode
• Using Docker image
• Specify environment variables
• Specify expose variables
• Run only some spec files
• Test project in subfolder
• Record results on Cypress Cloud
• Getting Git information environment variables
• Getting PR and URL automatically
• Overwriting Merge SHA into SHA message
• Tag recordings
• Specify auto cancel after failures
• Store test artifacts on GitHub
• Quiet output
• Set Cypress config values
• Use specific config file
• Run tests in parallel
• Combine Component and E2E testing
• Build app before running the tests
• Start server before running the tests
• Start multiple servers before running the tests
• Wait for server to respond before running the tests
• Use custom install command
• Use command prefix
• Use custom test command
• Pass custom build id when recording to Cypress Cloud
• Generate a robust custom build id to allow re-running the workflow
• Use different working-directory
• Use subfolders
• Use pnpm
• Use pnpm workspaces
• Use Yarn Classic
• Use Yarn Modern
• Use Yarn Plug'n'Play
• Use Yarn workspaces
• Disable package manager cache
• Use custom cache key
• Run tests on multiple Node versions
• Split install and tests into separate jobs
• Split install and tests with artifacts
• Use custom install commands
• Install only Cypress to avoid installing all dependencies
• Use timeouts to avoid hanging CI jobs
• Print Cypress info like detected browsers
• Run tests nightly or on any schedule
• Specify job summary title
• Suppress job summary
• More examples

Examples contained in this repository, based on current Cypress versions, can be found in the examples directory.

Live examples, such as example-basic.yml are shown together with a status badge. Click on the status badge to read the source code of the workflow, for example

Note: this package assumes that cypress is declared as a development dependency in the package.json file. The cypress npm module is required to run Cypress via its Module API.

End-to-End Testing

name: End-to-end tests
on: push
jobs:
  cypress-run:
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v7
      # Install dependencies with caching
      # and run all Cypress tests
      - name: Cypress run
        uses: cypress-io/github-action@v7

The workflow file example-basic.yml shows how Cypress runs on GH Actions using Ubuntu (22.04 and 24.04), Windows, and macOS without additional OS dependencies necessary.

This workflow uses the default test type of End-to-End (E2E) Testing. Alternatively, Component Testing can be utilized by referencing the Component Testing section below.

Component Testing

To use Cypress Component Testing add component: true

name: Component tests
on: push
jobs:
  cypress-run:
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v7
      - name: Cypress run
        uses: cypress-io/github-action@v7
        with:
          component: true

See the example project component-tests and the example-component-test.yml workflow for more details.

Action version

Best practice:

Our examples specify using branch v7 which is the action's recommended major version:

- name: Cypress run
  uses: cypress-io/github-action@v7

When using cypress-io/github-action@v7 from your workflow file, you will automatically use the latest tag from branch v7.

Alternatively, to mitigate unforeseen breaks, bind to a specific tag, for example:

- name: Cypress run
  uses: cypress-io/github-action@v7.0.0

The changes associated with each tag are shown under GitHub's [releases](http