docs: rework recording instructions with CYPRESS_RECORD_KEY#1443
Merged
jennifer-shehane merged 1 commit intoApr 29, 2025
Conversation
Collaborator
|
This comment was marked as outdated.
This comment was marked as outdated.
jennifer-shehane
approved these changes
Apr 29, 2025
|
🎉 This PR is included in version 6.8.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Situation
The README document contains several examples for recording to Cypress Cloud including:
There are several issues:
CYPRESS_RECORD_KEY.CYPRESS_RECORD_KEY. It must be passed as an environment variable.Not all recording examples contain the minimum of including a
CYPRESS_RECORD_KEYenvironment 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
projectIdand "record key".Align the README example variable names with the ones used in .github/workflows/example-recording.yml
EXAMPLE_PROJECT_IDEXAMPLE_RECORDING_KEYEnsure that all recording examples include
CYPRESS_RECORD_KEYfor consistency.