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

Allow to specify macos-min-version externally #3756

Merged

Conversation

APshenkin
Copy link
Contributor

@APshenkin APshenkin commented Sep 19, 2024

Description

Wails setup mmacosx-version-min while building the app. However there could be the cases, when developers want to specify higher min version. Currently it's not possible, cause latest mmacosx-version-min is taken as priority

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration using wails doctor.

  • Windows
  • macOS
  • Linux

Test Configuration

Please paste the output of wails doctor. If you are unable to run this command, please describe your environment in as much detail as possible.

Checklist:

  • I have updated website/src/pages/changelog.mdx with details of this PR
  • My code follows the general coding style of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • New Features
    • Added the ability to specify the minimum macOS version externally in project configuration.
  • Bug Fixes
    • Improved command generation by preventing duplication of the macOS version flag, enhancing execution reliability.
    • Fixed memory issues on Darwin.
    • Enhanced JSON compatibility for author names.
    • Improved handling of file drop events on Windows.
  • Documentation
    • Added a new section in CLI documentation for setting a minimal version for macOS applications.
    • Introduced information regarding UPX on Apple Silicon in the CLI documentation.
    • Updated documentation to indicate that ZoomFactor and IsZoomControlEnabled options are now Windows-only.

Copy link
Contributor

coderabbitai bot commented Sep 19, 2024

Walkthrough

The changes made to the CompileProject function in the BaseBuilder class involve the addition of a conditional check to prevent appending the -mmacosx-version-min=10.13 flag multiple times in the command string. This check ensures that the flag is only added if it is not already present, enhancing the reliability of the command generation process. Additionally, a specification for an external macos-min-version has been introduced, improving configurability. The changelog has also been updated to reflect these changes along with several bug fixes and modifications.

Changes

Files Change Summary
v2/pkg/commands/build/base.go Added conditional checks in CompileProject to prevent duplicate -mmacosx-version-min flags and specified external macos-min-version in project configuration.
website/docs/reference/cli.mdx Added documentation for setting minimal macOS version and information regarding UPX on Apple Silicon.
website/src/pages/changelog.mdx Updated changelog to reflect new features, bug fixes, and modifications for previous versions, including Windows-specific options.

Possibly related PRs

Suggested reviewers

  • leaanthony

Poem

In the land of code, where flags do play,
A rabbit hops in, to keep bugs at bay.
With checks in place, no duplicates found,
Our commands now sing, with a joyful sound!
So let’s celebrate, with a hop and a cheer,
For clean code is here, let’s spread the good cheer! 🐇✨


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 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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link
Member

@leaanthony leaanthony left a comment

Choose a reason for hiding this comment

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

Could you please update the documentation? Thank you 🙏

@APshenkin
Copy link
Contributor Author

@leaanthony missed your comment, sorry for delay.

I added note in documentation for this

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

🧹 Outside diff range and nitpick comments (1)
website/docs/reference/cli.mdx (1)

106-111: Approve addition with minor grammatical corrections

The new info box providing information on setting a minimal version for macOS is a valuable addition to the documentation. It offers clear instructions on how to override the default minimal version, which aligns well with the PR objectives.

However, there are two minor grammatical issues to address:

  1. "MacOS" should be "macOS" for consistency with Apple's branding.
  2. Consider adding "the" before "default" in the second sentence for improved readability.

Here's a suggested revision for the content:

:::info Set minimal version for macOS

You can override the default [minimal version](../gettingstarted/installation#supported-platforms) of macOS for your app by providing version via `CGO_CFLAGS` and `CGO_LDFLAGS` environment variables.
e.g. `CGO_CFLAGS=-mmacosx-version-min=10.15.0 CGO_LDFLAGS=-mmacosx-version-min=10.15.0 wails build`

:::
🧰 Tools
🪛 LanguageTool

[grammar] ~106-~106: The operating system from Apple is written “macOS”.
Context: .... ::: :::info Set minimal version for MacOS You can override default [minimal vers...

(MAC_OS)


[uncategorized] ~108-~108: You might be missing the article “the” here.
Context: ...mal version for MacOS You can override default [minimal version](../gettingstarted/ins...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 02c8361 and 1e23677.

📒 Files selected for processing (2)
  • website/docs/reference/cli.mdx (1 hunks)
  • website/src/pages/changelog.mdx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • website/src/pages/changelog.mdx
🧰 Additional context used
🪛 LanguageTool
website/docs/reference/cli.mdx

[grammar] ~106-~106: The operating system from Apple is written “macOS”.
Context: .... ::: :::info Set minimal version for MacOS You can override default [minimal vers...

(MAC_OS)


[uncategorized] ~108-~108: You might be missing the article “the” here.
Context: ...mal version for MacOS You can override default [minimal version](../gettingstarted/ins...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🔇 Additional comments (2)
website/docs/reference/cli.mdx (2)

Line range hint 112-116: Approve addition of UPX on Apple Silicon information

The new info box about UPX issues on Apple Silicon is a valuable addition to the documentation. It provides important information for developers using Apple Silicon devices and includes a link to the relevant GitHub issue for those seeking more details.

This addition aligns well with the PR objectives by enhancing the documentation with platform-specific considerations.

🧰 Tools
🪛 LanguageTool

[grammar] ~106-~106: The operating system from Apple is written “macOS”.
Context: .... ::: :::info Set minimal version for MacOS You can override default [minimal vers...

(MAC_OS)


[uncategorized] ~108-~108: You might be missing the article “the” here.
Context: ...mal version for MacOS You can override default [minimal version](../gettingstarted/ins...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


Line range hint 106-116: Overall assessment: Valuable additions to the CLI documentation

The changes made to this file enhance the documentation by providing important information for macOS developers. The additions about setting a minimal macOS version and UPX issues on Apple Silicon are well-placed and relevant.

These changes align perfectly with the PR objectives of allowing developers to specify a higher minimum macOS version and improving the overall documentation. The new content will be beneficial for users working with macOS and Apple Silicon devices.

🧰 Tools
🪛 LanguageTool

[grammar] ~106-~106: The operating system from Apple is written “macOS”.
Context: .... ::: :::info Set minimal version for MacOS You can override default [minimal vers...

(MAC_OS)


[uncategorized] ~108-~108: You might be missing the article “the” here.
Context: ...mal version for MacOS You can override default [minimal version](../gettingstarted/ins...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

@APshenkin
Copy link
Contributor Author

@leaanthony not sure why, but some mandatory checks for tests don't run. Should them been triggered somehow?

Copy link

@leaanthony leaanthony merged commit a964be1 into wailsapp:master Oct 20, 2024
7 checks passed
@leaanthony
Copy link
Member

Thanks again @APshenkin 🙏

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.

2 participants