Configuration Syntax: Cypress

Please refer to the Common Configuration Syntax Referencefor information regarding fields such as apiVersion, kind, suites, sauce, etc.

Example Configuration#

.sauce/config.yml
loading...
See full example on GitHub

cypress#

Description: Details specific to the cypress configuration.

Type: object

Example:

cypress:
version: 6.6.0
configFile: "cypress.json"

version#

Description: Version of cypress to use during tests.

Type: string

Example:

version: ##VERSION##

configFile#

Description: The designated cypress configuration file. saucectl determines related files based on the location of the config file. By default saucectl defers to the test file location defined in cypress.json.

Type: string

Example:

configFile: "cypress.json"

record#

Description: Record video of tests running.

Type: boolean

Example:

record: true
key: $MY_SECRET_KEY

key#

Description: Secret record key.

Type: string

Example:

record: true
key: $MY_SECRET_KEY

The record and key fields depend on the cypress "projectId" being set in your cypress.json file because the value of your projectId correlates directly with the value of the key field. See Cypress Project-ID Documentation for details about how to configure/retrieve the cypress projectId or Cypress Record-Key Documentation for details about configuring Record-Key parameters.

note

For additional information regarding cypress configurations, please consult the Cypress documentation.

config#

Description: Details specific to the cypress test configuration

Type: object

Example:

suites:
- name: "Hello"
browser: "firefox"
platformName: "Windows 10"
config:
env:
hello: world
testFiles: [ "**/*.*" ]

env#

Description: Any ephemeral/environment variables needed to run cypress tests.

Type: string | int | float | boolean

Example:

env:
hello: world

testFiles#

Description: The specific location of the cypress test files (if not otherwise specified explicitly in cypress.json).

Type: string array | string | regex

Example:

testFiles: [ "**/*.*" ]
Last updated on by Nancy Sweeney