spotlight icon indicating copy to clipboard operation
spotlight copied to clipboard

Document turbo.json environment variable configuration for SENTRY_SPOTLIGHT

Open dcramer opened this issue 5 months ago • 0 comments

Summary

The documentation should include information about configuring the SENTRY_SPOTLIGHT environment variable in turbo.json for monorepo setups using Turborepo.

Context

When using Spotlight in a Turborepo monorepo, users need to configure environment variables properly to ensure Spotlight works across all packages/apps. The SENTRY_SPOTLIGHT environment variable needs to be declared in turbo.json for it to be available during builds and development.

Proposed Documentation Addition

Add a section explaining how to configure turbo.json for Spotlight:

{
  "globalEnv": ["SENTRY_SPOTLIGHT"],
  // or in pipeline configuration
  "pipeline": {
    "build": {
      "env": ["SENTRY_SPOTLIGHT"]
    },
    "dev": {
      "env": ["SENTRY_SPOTLIGHT"]
    }
  }
}

Benefits

  • Helps users working with Turborepo monorepos
  • Prevents confusion about why Spotlight might not be working in certain packages
  • Provides clear guidance for environment variable configuration

🤖 Generated with Claude Code

dcramer avatar Aug 04 '25 22:08 dcramer