-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Open
Labels
Description
Issue
GitHub Actions workflows recording into Cypress Cloud are using an outdated name dashboardRecordKey to set the CYPRESS_RECORD_KEY environment variable. The name dashboardRecordKey is aligned to the previous branding of "Cypress Cloud" when it was called "Cypress Dashboard".
Suggestion
Replace dashboardRecordKey with EXAMPLE_RECORDING_KEY in GitHub Actions workflows.
Rationale
- The name
EXAMPLE_RECORDING_KEYis already in use in the cypress-io/github-action repo in example recording workflows. Using a consistent name makes it easier for users working from examples across different Cypress repositories. EXAMPLE_RECORDING_KEYis a neutral name which expresses its use as an example. It does not depend on Cypress Cloud branding.
Implementation steps
- Add a new GitHub secret named
EXAMPLE_RECORDING_KEYwith the same contents as the currentdashboardRecordKey. The Cypress Cloud projectId is4b7344and the Record Key can be obtained from https://cloud.cypress.io/projects/4b7344/settings by anyone with access to the settings of this project (doesn't include me).
| projectId: '4b7344', |
-
Once the secret
EXAMPLE_RECORDING_KEYis available, convert the GitHub Actions workflows to use the new name. Update any relevant text to refer consistently to "Cypress Cloud" and not "dashboard". -
After workflows have been converted, delete the secret
dashboardRecordKey.