[feature request] Allow setting --record switch with env var

[pieh]

Current behavior:

Right now you can specify Project ID and key with env vars (CYPRESS_PROJECT_ID, CYPRESS_RECORD_KEY). But you do need to use CLI --record switch to actually make use of them. If you use --record flag without those env vars you get error:

You passed the --record flag but this project has not been setup to record.

This project is missing the 'projectId' inside of 'cypress.json'.

We cannot uniquely identify this project without this id.

You need to setup this project to record. This will generate a unique 'projectId'.

Alternatively if you omit the --record flag this project will run without recording.

https://on.cypress.io/recording-project-runs

This makes it challenging (or messy) to use scripts that would work when those env vars are set and when they are not. In our setup we want to record runs to dashboard only when run in CI and not when running them locally (to not pollute dashboard with any test runs that devs will run locally when testing their changes.

As solution/workaround we use scripts like "cy:run": "(is-ci && cypress run --browser chrome --record) || cypress run --browser chrome" to apply --record switch only in CI. ( gatsbyjs/gatsby#16190 )

Desired behavior:

I'd like to be able to use env var like CYPRESS_RECORD=true to control all recording related options with env vars.

Steps to reproduce: (app code and test code)

• create single script to run cypress test suites (with --record switch)
• specify CYPRESS_PROJECT_ID, CYPRESS_RECORD_KEY in your CI setup
• try running script locally without above env vars set

Versions

cypress: 3.3.2

[pieh]

I'm happy to dive in, implement it and open pull request if this would be accepted

[jennifer-shehane]

Yes, this sounds like a great use case. We would happily accept a PR.

[brian-mann]

Sure, this feature sounds fine. We would accept a PR for this or one of our devs could likely knock it quickly.

At the moment I suggest you writing your own scripts/run-cypress.js file that you use to determine whether to record in cypress or not. At least then you could more easily programmatically build up an options object to pass to cypress.run(...)

[kthy]

If anybody ever gets around to this, it seems to me it would make sense to tackle #938 at the same time: Make it possible to set CYPRESS_RECORD_KEY in cypress.env.json.

[rupesh1395kumar]

Any solution for this one
You passed the --record flag but this project has not been setup to record.

This project is missing the projectId inside of: cypress.config.ts

We cannot uniquely identify this project without this id.

You need to setup this project to record. This will generate a unique projectId.

Alternatively if you omit the --record flag this project will run without recording.

[MikeMcC399]

@rupesh1395kumar

You should be able to follow the documentation on

https://docs.cypress.io/guides/cloud/getting-started#Setup

in order to set up Cypress to record to the Cypress Cloud.

(click on button) links to the Cypress technical community on Discord and there is a separate channel for cypress-cloud if you would like to get help from the Cypress community.