cypress-workflows

Reusable Cypress workflows for GitHub Actions

Call these workflows from your GitHub Action workflows, a single line (with parameters) let's you run N parallel test jobs without any configuration.

Example

Check out the source code, install and cache dependencies, and run all Cypress specs using the following workflow

name: ci
on: [push]
jobs:
  test:
    # use the reusable workflow to check out the code, install dependencies
    # and run the Cypress tests
    # https://github.com/bahmutov/cypress-workflows
    uses: bahmutov/cypress-workflows/.github/workflows/standard.yml@v1

Record the run

To record the test run on the Cypress Dashboard, pass the options to the workflow and the record key as a secret

name: ci
on: [push]
jobs:
  test:
    # use the reusable workflow to check out the code, install dependencies
    # and run the Cypress tests
    # https://github.com/bahmutov/cypress-workflows
    uses: bahmutov/cypress-workflows/.github/workflows/standard.yml@v1
    with:
      record: true
    secrets:
      recordKey: ${{ secrets.CYPRESS_RECORD_KEY }}

Parallel example

Let's split all tests across 3 machines using Cypress Parallelization

name: ci
on: [push]
jobs:
  test:
    # https://github.com/bahmutov/cypress-workflows
    uses: bahmutov/cypress-workflows/.github/workflows/parallel.yml@v1
    with:
      n: 3
    secrets:
      recordKey: ${{ secrets.CYPRESS_RECORD_KEY }}

Result:

Workflows

• standard.yml checks out code, installs dependencies, and runs tests on a single machine
• parallel.yml lets you specify the number if test machines to use

The workflows allow passing pretty much all Cypress GH Action parameters, see the individual workflow YML file.

Versions

Advice: use an explicit release tag when using a workflow like parallel.yml@v1.0.1. You might also use the latest release from the major branch v1 like parallel.yml@v1. Not recommended: using the latest commit on the branch parallel.yml@main or using a specific commit parallel.yml@2a9d460.

Examples

• bahmutov/cypress-workflows-example shows how to use the standard and the parallel workflows
• cypress-3rd-party-script-example shows how to run the end-to-end tests using the standard workflow before deploying the site
• cypress-wordle
• react-app-actions shows how to run the tests using a workflow and then release a new version using semantic release step
• bahmutov/cypress-recurse
• bahmutov/my-svelte-app
• bahmutov/sudoku-testing-v10 runs E2E and component tests using Cypress v10

Small print

Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2021

• @bahmutov
• glebbahmutov.com
• blog
• videos
• presentations
• cypress.tips

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2021 Gleb Bahmutov <gleb.bahmutov@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.