docs: add guide for debug/release APK install conflicts #347
Conversation
WalkthroughThe PR updates the Android Release Signing configuration example with revised placeholder values (storeFile, storePassword, keyPassword, keyAlias) and safety-focused comments. Additionally, it adds documentation explaining Android install conflicts when mixing debug and release APKs built with different signing keys. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
android/key.properties.example (1)
9-9: Consider clarifying the keystore file location.The
storeFilepath is relative. Consider adding a comment clarifying that this path should be relative to theandroid/directory (e.g.,android/upload-keystore.jks), or include guidance on where users should place the keystore file.Apply this diff to add clarification:
+# Place your keystore file in the android/ directory storeFile=upload-keystore.jks
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
android/key.properties.example(1 hunks)docs/DEBUG_RELEASE_CONFLICT.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
{android,ios,web}/**
📄 CodeRabbit inference engine (AGENTS.md)
Keep platform wrapper code in android/, ios/, and web/
Files:
android/key.properties.example
docs/**
📄 CodeRabbit inference engine (AGENTS.md)
Store additional project guidance and documentation in docs/
Files:
docs/DEBUG_RELEASE_CONFLICT.md
🧠 Learnings (1)
📚 Learning: 2025-10-22T12:29:26.971Z
Learnt from: CR
PR: MostroP2P/mobile#0
File: CLAUDE.md:0-0
Timestamp: 2025-10-22T12:29:26.971Z
Learning: Applies to android/local.properties : Never commit android/local.properties or secrets it may contain (should be git-ignored)
Applied to files:
android/key.properties.example
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
🔇 Additional comments (6)
docs/DEBUG_RELEASE_CONFLICT.md (5)
1-11: Excellent problem description!The explanation clearly articulates the root cause of the signing conflict and provides good context for users encountering this issue.
26-37: Clear permanent solution guidance.Good approach to reference the detailed setup guide rather than duplicating information. The bullet list provides helpful context about what users will find in the referenced guide.
38-52: Helpful additional context!The verification command and alternative approach guidance add valuable practical information for different user scenarios.
16-22: Package name verified as correct.The
applicationIdinandroid/app/build.gradleisnetwork.mostro.app, which matches theadb uninstallcommand in the documentation. No changes needed.
55-56: Documentation URLs are accessible and valid.Both reference links return HTTP 200 status codes, confirming they resolve correctly and provide the expected content. No issues found.
android/key.properties.example (1)
7-7: Documentation reference verified.The referenced file
docs/GITHUB_SECRETS_SETUP.mdexists in the repository, so users can access the complete setup instructions as intended.
Added documentation to solve the common conflict when switching between
flutter run(debug) and release APKs from GitHub Actions.related with issue #46
Summary by CodeRabbit