Cypress CircleCI Orb Example

Cypress CircleCI Orb

Introduction

This project installs npm dependencies, runs Cypress tests and records the output to the Cypress Dashboard on CircleCI. See .circleci/config.yml:

version: 2.1
orbs:
  cypress: cypress/cypress@dev:0.0.1
workflows:
  build:
    jobs:
      # record Cypress tests on the Dashboard
      - cypress/run:
          group: "all tests"
          record: true

Or you can run without recording on the dashboard:

version: 2.1
orbs:
  cypress: cypress/cypress@dev:0.0.1
workflows:
  build:
    jobs:
      - cypress/run

The hierarchy:

Workflow -> Jobs --> Commands -> define steps
             -> run on Executors

Development

• Check if you are correctly using the Cypress CircleCI Orb in the .circleci/config.yml file by running npm run validate.
• You can expand all commands from the orb and see how the "processed" .circleci/config.yml looks during the run on CircleCI. Execute npm run process to print the processed YAML in the terminal.