docs(mobile): add SENTRY_DISABLE_AUTO_UPLOAD=true to build apk without sentry dsn#2700
Conversation
WalkthroughAdded Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Greptile SummaryThis PR adds a single documentation line to the mobile setup guide advising developers to set Confidence Score: 5/5Documentation-only change; safe to merge. The single added line is correct and helpful. The only feedback is a P2 suggestion to improve clarity about how to apply the env var. No files require special attention. Important Files Changed
Prompt To Fix All With AIThis is a comment left during a code review.
Path: docs/docs/08-development/01-setup.md
Line: 172
Comment:
**Missing guidance on how to set the env var**
The note tells developers *what* to add but not *where*. Most developers hitting this issue will be doing a release or preview build (as shown in the PR's error trace). Adding a short example — e.g., prefixing the build command — would make this immediately actionable.
```suggestion
In 99% of the cases, you also probably want to add `SENTRY_DISABLE_AUTO_UPLOAD=true` when running preview or release builds, unless you have your own Sentry project DSN configured — otherwise the build will fail. You can set it inline, e.g.:
```sh
SENTRY_DISABLE_AUTO_UPLOAD=true pnpm --filter @karakeep/mobile android:release
```
```
How can I resolve this? If you propose a fix, please make it concise.Reviews (1): Last reviewed commit: "docs(mobile): add SENTRY_DISABLE_AUTO_UP..." | Re-trigger Greptile |
|
|
||
| In 90% of the cases, you'll want to use the development variant. | ||
|
|
||
| In 99% of the cases, you also probably want to add `SENTRY_DISABLE_AUTO_UPLOAD=true`, unless you have your own sentry project DSN to provide, otherwise, the build will fail. |
There was a problem hiding this comment.
Missing guidance on how to set the env var
The note tells developers what to add but not where. Most developers hitting this issue will be doing a release or preview build (as shown in the PR's error trace). Adding a short example — e.g., prefixing the build command — would make this immediately actionable.
| In 99% of the cases, you also probably want to add `SENTRY_DISABLE_AUTO_UPLOAD=true`, unless you have your own sentry project DSN to provide, otherwise, the build will fail. | |
| In 99% of the cases, you also probably want to add `SENTRY_DISABLE_AUTO_UPLOAD=true` when running preview or release builds, unless you have your own Sentry project DSN configured — otherwise the build will fail. You can set it inline, e.g.: | |
| ```sh | |
| SENTRY_DISABLE_AUTO_UPLOAD=true pnpm --filter @karakeep/mobile android:release |
<details><summary>Prompt To Fix With AI</summary>
`````markdown
This is a comment left during a code review.
Path: docs/docs/08-development/01-setup.md
Line: 172
Comment:
**Missing guidance on how to set the env var**
The note tells developers *what* to add but not *where*. Most developers hitting this issue will be doing a release or preview build (as shown in the PR's error trace). Adding a short example — e.g., prefixing the build command — would make this immediately actionable.
```suggestion
In 99% of the cases, you also probably want to add `SENTRY_DISABLE_AUTO_UPLOAD=true` when running preview or release builds, unless you have your own Sentry project DSN configured — otherwise the build will fail. You can set it inline, e.g.:
```sh
SENTRY_DISABLE_AUTO_UPLOAD=true pnpm --filter @karakeep/mobile android:release
How can I resolve this? If you propose a fix, please make it concise.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
There was a problem hiding this comment.
in this example, it does seem like greptile gave a better suggestion ^^
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/docs/08-development/01-setup.md`:
- Around line 172-173: The docs mention SENTRY_DISABLE_AUTO_UPLOAD=true but
don't tell where to set it and the sentence is awkward; update the sentence to
be clearer and add concrete examples: show using it as a prefixed env var for
local runs (e.g., SENTRY_DISABLE_AUTO_UPLOAD=true pnpm ios and
SENTRY_DISABLE_AUTO_UPLOAD=true pnpm android) and note the alternative of adding
SENTRY_DISABLE_AUTO_UPLOAD=true to the mobile app .env (apps/mobile/.env) or
exporting it in the shell, and rewrite the line to read something like "If you
don't have a Sentry DSN, set SENTRY_DISABLE_AUTO_UPLOAD=true to avoid build
failures — either prefix the command (SENTRY_DISABLE_AUTO_UPLOAD=true pnpm
android/ios), export it in your shell, or add it to apps/mobile/.env."
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 02ed9056-8741-44a7-9a4f-ed4148cc303a
📒 Files selected for processing (1)
docs/docs/08-development/01-setup.md
|
@xuatz should we add this to the package.json script instead? The actual workflow that builds the apps doesn't use the package.json scripts, so it should be safe |
@MohamedBassem oh is that so? okay then let's put it in the script instead then! |
|
thank you! |
Summary
Notes
Example of build failure