Fix: Add colon after cypress/run key

daltobello commented 8 months ago

The documentation showing how to configure the Cypress CircleCI Orb via the circleci/config.yml file does not include a required colon after the mapping key cypress/run in the example under the "Basic Setup" heading. Without a colon, the CircleCI build fails.
In the subsequent circleci/config.yml file illustrations for Parallelization and Additional Examples, a colon is included.
By highlighting this inconsistency, I aim to clarify the proper orb setup that adheres to YAML syntax. This will make it easier for others to install, cache, and run Cypress tests in CircleCI, aligning with the documentation's recommendations.
Below is the YAML configuration with the colon separating the key from its associated value.

version: 2.1
orbs:
  cypress: cypress-io/cypress@3
workflows:
  build:
    jobs:
      - cypress/run:
          start-command: 'npm run start'

CLAassistant commented 8 months ago

All committers have signed the CLA.

cypress-app-bot commented 8 months ago

Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.

jordanpowell88 commented 8 months ago

cypress-io / circleci-orb