v1.2.0: feat: store screenshots and videos as test artifacts on CircleCI

stores any generated screenshots and videos locally on CircleCI as test artifacts.

Example

version: 2.1
  orbs:
    cypress: cypress-io/[email protected]
  workflows:
    build:
      jobs:
        - cypress/run:
            store_artifacts: true

v1.1.2: fix: remove group name unless user passes one

to avoid triggering paid plan feature check

v1.1.1: remove job "hello"

Removed dummy job and command "hello" used for exploring how to write orb

v1.1.0: feat: add wait-on parameter

Allows to delay tests until the server responds

Example

Starts server, waits for it to respond and then runs all Cypress tests. Uses npx wait-on ... command under the hood, see wait-on

version: 2.1
orbs:
  cypress: cypress-io/[email protected]
workflows:
  build:
    jobs:
      - cypress/run:
          start: npm start
          wait-on: 'http://localhost:4200'

Note: if you are using webpack development server, it does not respond to HEAD requests, so you need to tell wait-on to use GET request like this

version: 2.1
orbs:
  cypress: cypress-io/[email protected]
workflows:
  build:
    jobs:
      - cypress/run:
          start: npm start
          wait-on: 'http-get://localhost:4200'

fix: base-10 image

Updated the image name used by default, otherwise cypress/base-10 was not found, see #34 (comment)

v1.0.0: public release

Public release of this Cypress CircleCI Orb

For full documentation see https://on.cypress.io/circleci-orb.

• examples
• jobs
• executors
• cypress-example-circleci-orb

v0.6.0: feat: custom test command

You can pass arbitrary test command

version: 2.1
orbs:
  cypress: cypress-io/[email protected]
workflows:
  build:
    jobs:
      # checks out code and installs dependencies once
      - cypress/run:
          command: 'npm run cy:run -- --record false'

v0.5.0: feat: pass spec parameter

You can select a subset of spec files to execute using spec: <glob> parameter

version: 2.1
orbs:
  cypress: cypress-io/[email protected]
workflows:
  build:
    jobs:
      - cypress/run:
          record: false
          spec: "cypress/integration/*-b.js"

v0.4.1: feat: executor and browser parameters

You can pass a custom executor name (which closely mirrors Cypress docker image name). You can also pass browser parameter. For example to run end-to-end tests using Chrome in a Docker image that has it installed

version: 2.1
orbs:
  cypress: cypress-io/[email protected]
workflows:
  build:
    jobs:
      - cypress/run:
          executor: cypress/browsers-chrome69
          browser: chrome