Skip to content

Conversation

@MikeMcC399
Copy link
Collaborator

@MikeMcC399 MikeMcC399 commented Apr 29, 2025

Situation

The README document contains several examples for recording to Cypress Cloud including:

There are several issues:

  • The first example is incomplete and does not run because it is missing the CYPRESS_RECORD_KEY.
  • In the Project ID and Record Key section, the comment about "typically" setting the recordKey as a CLI parameter is out-of-place, because the Cypress GitHub Action only uses CLI options exceptionally, not typically, and there is no equivalent action parameter to pass the CYPRESS_RECORD_KEY. It must be passed as an environment variable.
  • Variable names used in the README are different from the ones used in .github/workflows/example-recording.yml

Not all recording examples contain the minimum of including a CYPRESS_RECORD_KEY environment variable.

Change

Merge the above two sections by combining the examples and removing the Project ID and Record Key header.

Align with terms on https://docs.cypress.io/cloud/account-management/projects for projectId and "record key".

Align the README example variable names with the ones used in .github/workflows/example-recording.yml

  • EXAMPLE_PROJECT_ID
  • EXAMPLE_RECORDING_KEY

Ensure that all recording examples include CYPRESS_RECORD_KEY for consistency.

@cypress-app-bot
Copy link

@MikeMcC399 MikeMcC399 added documentation Improvements or additions to documentation Cypress Cloud labels Apr 29, 2025
@MikeMcC399 MikeMcC399 self-assigned this Apr 29, 2025
@MikeMcC399

This comment was marked as outdated.

@MikeMcC399 MikeMcC399 marked this pull request as ready for review April 29, 2025 06:32
@jennifer-shehane jennifer-shehane merged commit 435b438 into cypress-io:master Apr 29, 2025
76 checks passed
@MikeMcC399 MikeMcC399 deleted the docs/recording-key branch April 29, 2025 14:42
@github-actions
Copy link

🎉 This PR is included in version 6.8.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Cypress Cloud documentation Improvements or additions to documentation released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants