fix: Add Windows support for Android builds and centralize documentation #8163
+366
−30
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add Windows-compatible build scripts for Android using duckscript - Update Android README with Windows-specific NDK configuration - Create comprehensive BUILD_FROM_SOURCE.md documentation - Update main README and Flutter README to reference centralized docs - Split Android build tasks into platform-specific variants Fixes AppFlowy-IO#5336: Build for Android on Windows + Documentation update
|
|
Reviewer's GuideThis PR adds Windows support for Android builds by introducing new platform-specific build tasks in the mobile makefile (using duckscript for Windows), centralizes all build instructions into a comprehensive BUILD_FROM_SOURCE.md, and updates existing READMEs to reference the new documentation while enriching the Android guide with OS-specific NDK configuration. Class diagram for new Android MainActivity and build scriptsclassDiagram
class MainActivity {
+FlutterActivity
}
MainActivity --|> FlutterActivity
class SdkBuildAndroid {
+mac_alias
+linux_alias
+windows_alias
}
class SdkBuildAndroidUnix {
+dependencies
+private
+script
+script_runner = "@shell"
}
class SdkBuildAndroidWindows {
+dependencies
+private
+script
+script_runner = "@duckscript"
}
SdkBuildAndroid --> SdkBuildAndroidUnix
SdkBuildAndroid --> SdkBuildAndroidWindows
File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @Akhash16 - I've reviewed your changes - here's some feedback:
- It looks like the editor’s
.historyfolders are being committed – please remove those files from the PR so we don’t check in local history. - You’ve duplicated Android setup instructions in both BUILD_FROM_SOURCE.md and the Android README; consider centralizing or linking to one canonical doc to avoid drift.
- The Windows build task only builds arm64-v8a, while the Unix scripts and CI cover multiple ABIs—please align the Windows scripts to support all required Android architectures.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- It looks like the editor’s `.history` folders are being committed – please remove those files from the PR so we don’t check in local history.
- You’ve duplicated Android setup instructions in both BUILD_FROM_SOURCE.md and the Android README; consider centralizing or linking to one canonical doc to avoid drift.
- The Windows build task only builds arm64-v8a, while the Unix scripts and CI cover multiple ABIs—please align the Windows scripts to support all required Android architectures.
## Individual Comments
### Comment 1
<location> `frontend/appflowy_flutter/README.md:35` </location>
<code_context>
+
+### What OS should I use for development?
+
+We support all OS for Development i.e. Linux, MacOS and Windows. We have detailed documentation on how to setup `AppFlowy_Flutter` on your local system for each operating system:
+
+- [Build from Source Guide](../../doc/BUILD_FROM_SOURCE.md) - Comprehensive setup instructions for all platforms
</code_context>
<issue_to_address>
Use 'macOS' instead of 'MacOS' for correct spelling.
Use 'macOS' with a lowercase 'm' and uppercase 'OS' to match Apple's official naming.
</issue_to_address>
<suggested_fix>
<<<<<<< SEARCH
We support all OS for Development i.e. Linux, MacOS and Windows. We have detailed documentation on how to setup `AppFlowy_Flutter` on your local system for each operating system:
=======
We support all OS for Development i.e. Linux, macOS and Windows. We have detailed documentation on how to setup `AppFlowy_Flutter` on your local system for each operating system:
>>>>>>> REPLACE
</suggested_fix>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
- Remove .history folders from commit - Fix 'macOS' spelling (was 'MacOS') - Add armeabi-v7a target to Windows Android build scripts for ABI parity - Remove duplicated Android setup instructions, reference dedicated guide instead - Remove unrelated Android app files from commit scope Addresses feedback from PR AppFlowy-IO#8163
|
Did all the stuff mentioned in the feedback. |
…khash16/AppFlowy into fix/android-windows-build-docs
Akhash16
force-pushed
the
fix/android-windows-build-docs
branch
from
f5496b8 to
0db720b
Compare
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
|
Please only update the code related to the Android build workflow. For documentation, please submit a PR in this repo: AppFlowy-Docs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #5336: Build for Android on Windows + Documentation update
Feature Preview
PR Checklist
Summary by Sourcery
Add Windows support for Android builds, refactor Android build tasks into platform-specific variants, and centralize all build instructions into a comprehensive documentation guide
New Features:
Enhancements:
CI:
Documentation: