Skip to content

docs(react-native): Document SENTRY_PROJECT_ROOT for monorepo setups #17269

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.

Sign up for GitHub

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

Open
antonis wants to merge 2 commits into
base: master
Choose a base branch
from
+10 −0
Open

docs(react-native): Document SENTRY_PROJECT_ROOT for monorepo setups #17269

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b17021
docs(react-native): Document SENTRY_PROJECT_ROOT env var for monorepo…
antonis Apr 7, 2026
4f9f32c
fix: Use Alert component instead of Note
antonis Apr 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/platforms/react-native/manual-setup/manual-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,16 @@ export SENTRY_CLI_RN_XCODE_EXTRA_ARGS="--extra --flags"
export SOURCE_MAP_PATH="path/to/source-maps" # From where collect-modules should read modules
export SENTRY_COLLECT_MODULES="path/to/collect-modules.sh"
export MODULES_PATHS="../node_modules,../my-custom-module"

export SENTRY_PROJECT_ROOT="/path/to/packages/mobile" # Override project root for monorepo setups
```

<Alert>

If you're using a monorepo (for example, NX or Turborepo), the script may resolve the project root incorrectly due to symlinked `node_modules`. Set `SENTRY_PROJECT_ROOT` to the absolute path of your React Native package to fix build failures caused by incorrect path resolution.

</Alert>

By default, uploading of source maps for debug simulator builds is disabled for speed reasons. If you want to generate source maps for debug builds, you can pass `--allow-fetch` as a parameter to `SENTRY_CLI_RN_XCODE_EXTRA_ARGS` in the above mentioned script.

### Configure Automatic Debug Symbols Upload
Expand All @@ -110,6 +118,8 @@ export SENTRY_INCLUDE_NATIVE_SOURCES=true # Upload native iOS sources
export SENTRY_CLI_EXECUTABLE="path/to/@sentry/cli/bin/sentry-cli"
export SENTRY_CLI_EXTRA_ARGS="--extra --flags" # Extra arguments for sentry-cli in all build phases
export SENTRY_CLI_DEBUG_FILES_UPLOAD_EXTRA_ARGS="--extra --flags"

export SENTRY_PROJECT_ROOT="/path/to/packages/mobile" # Override project root for monorepo setups
```

For more information about what options to use in `SENTRY_CLI_DEBUG_FILES_UPLOAD_EXTRA_ARGS` visit the [Sentry CLI Apple Debug Symbols](/platforms/apple/dsym/#sentry-cli) documentation.
Expand Down
Loading