E2E testing documentation updates #18649
Open
+294
−0
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.
Before submitting a pull request, please take a look at our
Contributing guidelines and verify:
yarn lint) & (yarn test).Closes #issue_link_here
This PR documents key learnings and best practices for E2E testing within the Sentry JavaScript SDKs, focusing on common pitfalls and setup requirements.
Why these changes?
To improve the developer experience for E2E testing by providing clear guidance on Verdaccio setup, the critical
.npmrcfile, bundler-specific behaviors, and debugging strategies, thereby reducing common issues and debugging time.What was changed?
CONTRIBUTING.md: Added a new section "Running E2E Tests Locally" with prerequisites, step-by-step instructions, and troubleshooting.CLAUDE.md&.cursor/rules/sdk_development.mdc: Added an "E2E Testing" section under "Development Guidelines," explaining Verdaccio,.npmrcrequirements, how to run single tests, and common pitfalls.dev-packages/e2e-tests/README.md: Expanded existing documentation with detailed.npmrcexplanations, a comprehensive troubleshooting guide, and notes on bundler-specific environment variable handling (Webpack, Vite, Next.js) andimport.meta.envbehavior.Closes #18651 (added automatically)