Skip to content
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.

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

[v3] Update Templates (macOS Target Version and Linux aarch64 AppImage) #3981

Merged
merged 6 commits into from
Jan 14, 2025

Conversation

AkshayKalose
Copy link
Contributor

@AkshayKalose AkshayKalose commented Jan 3, 2025

  • [v3] Update Templates (macOS Target Version and Linux aarch64 AppImage)

The changes are tested and working on the repo: https://github.com/grpcmd/grpcmd-gui

Summary by CodeRabbit

  • System Requirements
    • Updated Linux build script to support architecture-specific linuxdeploy tool download.
    • Increased minimum macOS version requirement from 10.13 to 10.15 for both development and production builds.
  • New Features
    • Added support for aarch64 (arm64) AppImage Linux builds.

Copy link
Contributor

coderabbitai bot commented Jan 3, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces changes to the build and configuration files for cross-platform application deployment. The modifications include architecture-specific handling for the Linux AppImage build script and an update to the minimum macOS version requirement for both development and production Info.plist templates. Additionally, the changelog has been updated to reflect these changes, enhancing compatibility and support for different system architectures and newer macOS versions.

Changes

File Change Summary
v3/internal/commands/build_assets/linux/appimage/build.sh Added architecture detection for linuxdeploy tool, supporting both x86_64 and arm64 architectures
v3/internal/commands/updatable_build_assets/darwin/Info.dev.plist.tmpl Updated minimum macOS version from 10.13.0 to 10.15.0
v3/internal/commands/updatable_build_assets/darwin/Info.plist.tmpl Updated minimum macOS version from 10.13.0 to 10.15.0
docs/src/content/docs/changelog.mdx Updated changelog to include support for aarch64 (arm64) AppImage Linux builds and minimum macOS version change

Sequence Diagram

sequenceDiagram
    participant Script as Build Script
    participant System as System Architecture
    participant Linuxdeploy as Linuxdeploy Tool

    Script->>System: Detect architecture
    alt x86_64 Architecture
        Script->>Linuxdeploy: Download x86_64 version
    else ARM64 Architecture
        Script->>Linuxdeploy: Download arm64 version
    end
    Script->>Linuxdeploy: Execute tool
Loading

Possibly related PRs

  • [v3] allow build with garble #3192: This PR includes updates to the changelog that mention support for aarch64 (arm64) AppImage Linux builds, which is relevant to the architecture-specific handling introduced in the main PR for downloading the appropriate version of linuxdeploy.
  • [v3] app quit on message #3990: The changelog update in this PR also mentions improvements related to application closure handling, which may indirectly relate to the overall robustness of the application, although it does not directly connect to the architecture-specific changes in the main PR.

Suggested labels

TODO

Poem

🐰 Hopping through code with glee and might,
Architectures dance in binary light!
From x86 to ARM, we adapt and grow,
macOS versions rise, our app's spirits glow 🚀
A rabbit's build, precise and bright! 🌟


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 193984e and 663766f.

📒 Files selected for processing (1)
  • docs/src/content/docs/changelog.mdx (2 hunks)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@AkshayKalose AkshayKalose changed the base branch from master to v3-alpha January 3, 2025 12:49
@AkshayKalose AkshayKalose changed the title v3 update templates [v3] Update Templates (macOS Target Version and Linux aarch64 AppImage) Jan 3, 2025
@AkshayKalose AkshayKalose marked this pull request as ready for review January 3, 2025 12:55
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
v3/internal/commands/updatable_build_assets/darwin/Info.plist.tmpl (1)

21-21: Acknowledge the new minimum macOS version requirement.

Raising LSMinimumSystemVersion from 10.13.0 to 10.15.0 will exclude users running older macOS versions (10.13–10.14). Ensure that this updated requirement aligns with your supported target audience.

v3/internal/commands/build_assets/linux/appimage/build.sh (2)

17-20: Consider verifying the downloaded file for security & integrity.

While this logic appropriately handles x86_64 architecture, it uses wget without checksum validation. Malicious or incomplete downloads are not detected.

You could do:

 if [[ $(uname -m) == *x86_64* ]]; then
+    # Optionally verify the download via checksums
     wget -q -4 -N https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage
     chmod +x linuxdeploy-x86_64.AppImage

25-31: Great addition of arm64 support.

This enables building for a broader range of Linux platforms. Consider implementing the same security checks and bundle verifications for arm64 that you do for x86_64 (e.g., checksums, debugging logs).

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 91a9929 and 5fbddf5.

📒 Files selected for processing (3)
  • v3/internal/commands/build_assets/linux/appimage/build.sh (1 hunks)
  • v3/internal/commands/updatable_build_assets/darwin/Info.dev.plist.tmpl (1 hunks)
  • v3/internal/commands/updatable_build_assets/darwin/Info.plist.tmpl (1 hunks)
🔇 Additional comments (2)
v3/internal/commands/updatable_build_assets/darwin/Info.dev.plist.tmpl (1)

21-21: Verify consistency with the production plist.

Mirroring the production plist’s requirement in the dev plist helps maintain a uniform target across development and production. Confirm that your dev users have at least macOS 10.15 installed.

v3/internal/commands/build_assets/linux/appimage/build.sh (1)

22-23: Confirm correct app bundling for x86_64.

Remember to verify that linuxdeploy-x86_64.AppImage properly includes all critical files and dependencies for your application bundle.

@leaanthony
Copy link
Member

Thanks 🙏 Please could you add an entry to the changelog located at docs/src/content/docs/changelog.mdx? Thanks!

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/src/content/docs/changelog.mdx (1)

60-60: Consider highlighting this as a breaking change and fix grammar.

This update to the minimum macOS system version requirement is a breaking change that could affect users with older systems. Additionally, there's a minor grammatical issue.

Apply this diff to improve the entry:

- Updated the minimum system version in macOS .plist files from 10.13.0 to 10.15.0
+ Updated the minimum system version on macOS .plist files from 10.13.0 to 10.15.0 (Breaking Change)
🧰 Tools
🪛 LanguageTool

[grammar] ~60-~60: The correct preposition appears to be “on”.
Context: ...2) - Updated the minimum system version in macOS .plist files from 10.13.0 to 10.1...

(IN_WINDOWS)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6629ed9 and 193984e.

📒 Files selected for processing (1)
  • docs/src/content/docs/changelog.mdx (2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/src/content/docs/changelog.mdx

[grammar] ~60-~60: The correct preposition appears to be “on”.
Context: ...2) - Updated the minimum system version in macOS .plist files from 10.13.0 to 10.1...

(IN_WINDOWS)

🔇 Additional comments (1)
docs/src/content/docs/changelog.mdx (1)

40-40: LGTM! Well-documented feature addition.

The changelog entry for aarch64 (arm64) AppImage Linux builds support is clear, properly attributed, and follows the changelog format guidelines.

@leaanthony leaanthony merged commit 9a54f58 into wailsapp:v3-alpha Jan 14, 2025
5 of 7 checks passed
@leaanthony
Copy link
Member

Thank you! 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Windows Webview2, Keyboard UK Extended, Typing German Umlaut
2 participants