Skip to content

update instructions on how to run locally #31630

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 2, 2025

Conversation

jennifer-shehane
Copy link
Member

  • Closes

Additional details

Steps to test

How has the user experience changed?

PR Tasks

@jennifer-shehane jennifer-shehane self-assigned this May 2, 2025
- Ensure the project has been setup in the `Cypress (staging)` is in staging environment or `Cypress Internal Org` if in production environment and has a `projectId` that represents that.
- Open a project that has `experimentalStudio: true` set in the `e2e` config of the `cypress.config.js|ts` file.
- Click to 'Add Commands to Test' after hovering over a test command.

Note: When using the `CYPRESS_LOCAL_STUDIO_PATH` environment variable, we bypass our error reporting and instead throw the exception immediately. The purpose of this is to try and surface issues immediately during local development.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Note: When using the `CYPRESS_LOCAL_STUDIO_PATH` environment variable, we bypass our error reporting and instead throw the exception immediately. The purpose of this is to try and surface issues immediately during local development.
Note: When using the `CYPRESS_LOCAL_STUDIO_PATH` environment variable, we bypass our Sentry error reporting and instead log out the errors to the CLI console or browser console.

Copy link
Collaborator

@ryanthemanuel ryanthemanuel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made some of my own changes, but looks good.

@jennifer-shehane jennifer-shehane merged commit d52f6f4 into develop May 2, 2025
81 of 89 checks passed
@jennifer-shehane jennifer-shehane deleted the update-studio-instructions branch May 2, 2025 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants