The recording example uses Cypress Cloud to record results using the Cypress Cloud projectId as defined in the cypress.config.js configuration file.
In order to use the recording example with your own Cypress Cloud project, you need to replace the projectId and record key with your own values.
Follow the Cypress Cloud documentation to sign up, if you do not already have an account, or to sign in if you have an account.
Create a new project if one does not exist.
Access "Project settings" in Cypress Cloud and copy the contents of each of the following parameters for the project into the Security settings of your GitHub fork, using "Secrets and variables" > "Actions", then "Secrets" for the "Project ID" and for the "Record Key" as in the table below:
| Cypress Cloud name | Actions name in fork | Variable type |
|---|---|---|
| Project ID | EXAMPLE_PROJECT_ID | Actions secrets |
| Record Keys | EXAMPLE_RECORDING_KEY | Actions secrets |
Refer to the GitHub documentation
When you have done this, the example recording will take the projectId from the EXAMPLE_PROJECT_ID variable instead of from the cypress.config.js configuration file.
This setup allows the example recording to run in your own Cypress Cloud project, whilst leaving the same example for use in the parent repository cypress-io/github-action unchanged. The parent repository has its own EXAMPLE_RECORDING_KEY defined as a secret and it uses the projectId as defined in the cypress.config.js configuration file.