Skip to content

Workflows use outdated name dashboardRecordKey #989

@MikeMcC399

Description

@MikeMcC399

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

  1. The name EXAMPLE_RECORDING_KEY is 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.
  2. EXAMPLE_RECORDING_KEY is a neutral name which expresses its use as an example. It does not depend on Cypress Cloud branding.

Implementation steps

  1. Add a new GitHub secret named EXAMPLE_RECORDING_KEY with the same contents as the current dashboardRecordKey. The Cypress Cloud projectId is 4b7344 and 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).

  1. Once the secret EXAMPLE_RECORDING_KEY is available, convert the GitHub Actions workflows to use the new name. Update any relevant text to refer consistently to "Cypress Cloud" and not "dashboard".

  2. After workflows have been converted, delete the secret dashboardRecordKey.

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions