docs(setup): add ruby installation step for ios and macos builds#3128
docs(setup): add ruby installation step for ios and macos builds#3128
Conversation
specific versions are redundant, as there are no currently known version constraints, and the team is generally using the latest available versions of all tools
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughUpdates Android build stack: Docker image bumps Android platform to 36 and NDK to 27.3.13750724; Gradle wrapper moves to 9.0.0; Android Gradle Plugin to 8.11.1; Kotlin plugin to 2.2.10. Documentation adds macOS Ruby (3.0+) and CocoaPods (1.15+) prerequisites and setup steps. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Poem
✨ Finishing touches🧪 Generate unit tests
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 review |
✅ Actions performedReview triggered.
|
|
Visit the preview URL for this PR (updated for commit 0409a41): https://walletrc--pull-3128-merge-mz7rlrsh.web.app (expires Thu, 18 Sep 2025 09:05:48 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: f66a4ff03faa546f12f0ae5a841bd9eff2714dcc |
![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 (7)
docs/BUILD_RUN_APP.md (4)
33-69: Ruby setup: avoid hard pin to 3.4.5 and add Intel path for chruby.
- Suggest phrasing “Ruby 3.0+ (recommend latest 3.4.x)” to reduce churn.
- Add Intel Homebrew path for chruby includes.
-## Ruby setup +## Ruby setup -On macOS, Ruby is required for CocoaPods and Xcode tooling. Install Ruby 3.0+ (recommended: 3.4.5) using one of these version managers: +On macOS, Ruby is required for CocoaPods and Xcode tooling. Install Ruby 3.0+ (recommended: latest 3.4.x) using one of these version managers: ```bash brew install rbenv echo 'eval "$(rbenv init -)"' >> ~/.zshrc # or ~/.bash_profile source ~/.zshrc || source ~/.bash_profile - rbenv install 3.4.5 - rbenv global 3.4.5 + rbenv install 3.4.5 + rbenv global 3.4.5 ruby -v@@
brew install chruby ruby-install - echo 'source /opt/homebrew/opt/chruby/share/chruby/chruby.sh' >> ~/.zshrc - echo 'source /opt/homebrew/opt/chruby/share/chruby/auto.sh' >> ~/.zshrc + # Apple Silicon: + echo 'source /opt/homebrew/opt/chruby/share/chruby/chruby.sh' >> ~/.zshrc + echo 'source /opt/homebrew/opt/chruby/share/chruby/auto.sh' >> ~/.zshrc + # Intel Macs: + # echo 'source /usr/local/opt/chruby/share/chruby/chruby.sh' >> ~/.zshrc + # echo 'source /usr/local/opt/chruby/share/chruby/auto.sh' >> ~/.zshrc source ~/.zshrc ruby-install ruby 3.4.5 chruby 3.4.5 ruby -v--- `71-81`: **CocoaPods install: prefer no sudo with version managers; add user-install note for system Ruby.** Using sudo with a managed Ruby can cause permission conflicts. ```diff -```bash -sudo gem install cocoapods -pod --version -``` +```bash +# If using rbenv/rvm/chruby (recommended): +gem install cocoapods +pod --version + +# If using the system Ruby: +gem install --user-install cocoapods +echo 'export GEM_HOME="$HOME/.gem"' >> ~/.zshrc && echo 'export PATH="$HOME/.gem/bin:$PATH"' >> ~/.zshrc +exec $SHELL -l +pod --version +```Also fix “XCode” capitalization elsewhere in this doc (Apple spells it “Xcode”).
121-123: Typo: “XCode” → “Xcode”.-1. Open `macos/Runner.xcworkspace` in XCode +1. Open `macos/Runner.xcworkspace` in Xcode
138-139: Typo: “XCode” → “Xcode”.-- Open `macos/Runner.xcworkspace` in XCode +- Open `macos/Runner.xcworkspace` in Xcodedocs/PROJECT_SETUP.md (3)
17-17: Typo: “Command Pallette” → “Command Palette”.- - enable `Dart: Use recommended settings` via the Command Pallette + - enable `Dart: Use recommended settings` via the Command Palette
25-26: Capitalization: “xCode” → “Xcode”.- - [xCode](https://developer.apple.com/xcode/) (latest, macOS only) + - [Xcode](https://developer.apple.com/xcode/) (latest, macOS only)
30-33: Mac prerequisites section is helpful; keep versions flexible.Consider “Ruby 3.0+ (latest 3.4.x)” and “CocoaPods 1.15+” to avoid frequent doc churn.
- - Ruby: 3.0+ (recommended: 3.4.5). See [Ruby setup](BUILD_RUN_APP.md#ruby-setup). + - Ruby: 3.0+ (recommended: latest 3.4.x). See [Ruby setup](BUILD_RUN_APP.md#ruby-setup).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
.docker/android-sdk.dockerfile(1 hunks)android/gradle/wrapper/gradle-wrapper.properties(1 hunks)android/settings.gradle(1 hunks)docs/BUILD_RUN_APP.md(3 hunks)docs/PROJECT_SETUP.md(1 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: takenagain
PR: KomodoPlatform/komodo-wallet#2528
File: android/gradle/wrapper/gradle-wrapper.properties:3-4
Timestamp: 2025-02-17T07:14:20.072Z
Learning: Java 21 requires Gradle version 8.5 or higher for compatibility in Android builds.
📚 Learning: 2025-08-31T19:24:53.317Z
Learnt from: CR
PR: KomodoPlatform/komodo-wallet#0
File: AGENTS.md:0-0
Timestamp: 2025-08-31T19:24:53.317Z
Learning: For Komodo Wallet repository work, consult `docs/BUILD_RUN_APP.md`, other files in `docs/`, and `README.md`
Applied to files:
docs/PROJECT_SETUP.md
📚 Learning: 2025-08-31T19:24:53.317Z
Learnt from: CR
PR: KomodoPlatform/komodo-wallet#0
File: AGENTS.md:0-0
Timestamp: 2025-08-31T19:24:53.317Z
Learning: For Komodo DeFi Flutter SDK repository, reference `/KDF_API_DOCUMENTATION.md` and applicable RPCs, data structures, and notes when implementing RPC-related features
Applied to files:
docs/PROJECT_SETUP.md
📚 Learning: 2025-02-17T07:14:20.072Z
Learnt from: takenagain
PR: KomodoPlatform/komodo-wallet#2528
File: android/gradle/wrapper/gradle-wrapper.properties:3-4
Timestamp: 2025-02-17T07:14:20.072Z
Learning: Java 21 requires Gradle version 8.5 or higher for compatibility in Android builds.
Applied to files:
android/settings.gradle
⏰ 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). (9)
- GitHub Check: build_and_preview
- GitHub Check: unit_tests
- GitHub Check: build-linux-docker
- GitHub Check: Build Desktop (linux)
- GitHub Check: validate_code_guidelines
- GitHub Check: Build Desktop (windows)
- GitHub Check: Build Mobile (iOS)
- GitHub Check: Build Mobile (Android)
- GitHub Check: build-android-docker
🔇 Additional comments (5)
android/gradle/wrapper/gradle-wrapper.properties (1)
3-4: Gradle 9 upgrade validated: distributionSha256Sum matches gradle-9.0.0-bin.zip, local JDK 17.0.16 meets Gradle 9’s requirement, and AGP 8.11.1 is in use and supported..docker/android-sdk.dockerfile (1)
29-33: Confirm SDK fetch and consider build-tools bump
- AGP 8.11 supports API level 36, so installing
platforms;android-36is correct.- You’re still on build-tools 35.0.1; if you encounter aapt2 or other tooling issues, plan to upgrade to the 36.x build-tools once available.
- Unable to run a cacheless Docker build in this CI sandbox (
docker buildfailed: command not found); please verify locally thatsdkmanagercan fetchplatforms;android-36.android/settings.gradle (1)
22-29: Plugin versions are sensible with Gradle 9; keep an eye on Studio/AGP constraints.
- AGP 8.11.1 works with Gradle 9, and Kotlin 2.2.x is supported by Gradle 9 (Gradle embeds Kotlin 2.2). (docs.gradle.org)
- The comment about AGP 8.13+ requiring targetSdk 35+ matches current guidance; staying on 8.11.1 is reasonable if dependencies still target 34. (developer.android.com)
docs/BUILD_RUN_APP.md (1)
331-341: Good call-out on macOS prerequisites before iOS steps.docs/PROJECT_SETUP.md (1)
34-34: Nice: placing flutter doctor after prerequisites reduces false negatives.
There was a problem hiding this comment.
Pull Request Overview
This PR updates Android build tooling to newer versions and adds comprehensive Ruby/CocoaPods setup documentation for iOS and macOS builds. The changes ensure compatibility with the latest Android development tools while providing clear guidance for Apple platform development prerequisites.
- Updates Android build stack with latest versions for improved tooling compatibility
- Adds detailed Ruby installation and version management documentation for macOS developers
- Provides CocoaPods installation guidance with version requirements
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/PROJECT_SETUP.md | Restructures setup steps and adds Ruby/CocoaPods prerequisites for macOS builds |
| docs/BUILD_RUN_APP.md | Adds comprehensive Ruby setup section with multiple version managers and CocoaPods installation guide |
| android/settings.gradle | Updates Android Gradle Plugin to 8.11.1 and Kotlin to 2.2.10 with compatibility notes |
| android/gradle/wrapper/gradle-wrapper.properties | Updates Gradle wrapper from 8.12.1 to 9.0.0 |
| .docker/android-sdk.dockerfile | Updates Android platform to 36 and NDK to 27.3.13750724 |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Summary by CodeRabbit
Chores
Documentation