Add darwin universal build and package #3902
Conversation
WalkthroughThe pull request updates the changelog to reflect new features, changes, and bug fixes within the project, including support for Darwin universal builds, enhancements to documentation, and new SvelteKit templates. It introduces new commands for asset updates and runtime generation, modifies existing functionality, and corrects structural definitions. Additionally, it includes significant updates to version 3.0.0-alpha.7, emphasizing improved functionality and user experience across platforms. Changes
Possibly related PRs
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![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
🧹 Outside diff range and nitpick comments (4)
v3/examples/file-association/Taskfile.yml (1)
35-47: Add error handling and verification steps to the universal build process.While the implementation follows the correct steps for creating a universal binary, it could benefit from additional robustness:
Consider applying these improvements:
darwin:build:universal: summary: Builds darwin universal binary (arm64 + amd64) cmds: - task: darwin:build vars: ARCH: amd64 - mv {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}-amd64 - task: darwin:build vars: ARCH: arm64 - mv {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}-arm64 - lipo -create -output {{.BIN_DIR}}/{{.APP_NAME}} {{.BIN_DIR}}/{{.APP_NAME}}-amd64 {{.BIN_DIR}}/{{.APP_NAME}}-arm64 + - lipo -verify_arch arm64 amd64 {{.BIN_DIR}}/{{.APP_NAME}} - rm {{.BIN_DIR}}/{{.APP_NAME}}-amd64 {{.BIN_DIR}}/{{.APP_NAME}}-arm64 + status: + - test -f {{.BIN_DIR}}/{{.APP_NAME}}mkdocs-website/docs/en/changelog.md (3)
21-21: Enhance the changelog entry with more detailsWhile the entry correctly documents the new feature, it would be more helpful to users if it included:
- Description of what "universal builds" means (e.g., support for both ARM64 and AMD64 architectures)
- The new tasks added (
darwin:build:universalanddarwin:package:universal)- Benefits or use cases for this feature
Consider expanding the entry like this:
-Added Support for darwin universal builds and packages by [ansxuman](https://github.com/ansxuman) in [#3902](https://github.com/wailsapp/wails/pull/3902) +Added Support for Darwin universal builds and packages (ARM64/AMD64) with new tasks `darwin:build:universal` and `darwin:package:universal`. This enables building applications that run natively on both Apple Silicon and Intel-based Macs. By [ansxuman](https://github.com/ansxuman) in [#3902](https://github.com/wailsapp/wails/pull/3902)
46-46: Add context to the build assets fix entryThe fix entry would be more valuable with additional context about what was broken and how it was fixed.
Consider expanding the entry like this:
-Fixed build assets update by @ansxuman in [#3901](https://github.com/wailsapp/wails/pull/3901) +Fixed build assets update to correctly handle asset updates when using the new `wails3 update build-assets` command by @ansxuman in [#3901](https://github.com/wailsapp/wails/pull/3901)
PR links in changelog need to be updated
The changelog entry for PR #3902 is premature as the PR is still in an OPEN state and hasn't been merged yet. It should be removed from the changelog until the PR is merged.
- Remove the entry "Added Support for darwin universal builds and packages by ansxuman in #3902" from the changelog as PR Add darwin universal build and package #3902 is not yet merged.
🔗 Analysis chain
Line range hint
1-24: Documentation follows changelog standardsThe changelog entries follow the Keep a Changelog format and properly categorize changes. The PR links and author attributions are consistent throughout.
Let's verify the PR links are valid:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify PR links in the changelog # Test: Check if PRs #3901 and #3902 exist and are accessible gh pr view 3901 gh pr view 3902Length of output: 14599
🧰 Tools
🪛 LanguageTool
[duplication] ~20-~20: Possible typo: you repeated a word
Context: ...erabilities. --> ## [Unreleased] ### Added - Added Support for darwin universal builds and...(ENGLISH_WORD_REPEAT_RULE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
mkdocs-website/docs/en/changelog.md(2 hunks)v3/examples/file-association/Taskfile.yml(1 hunks)
🔇 Additional comments (1)
v3/examples/file-association/Taskfile.yml (1)
49-54: Add output validation and improve task documentation.
The packaging task could benefit from additional documentation and validation steps:
Consider applying these improvements:
darwin:package:universal:
- summary: Packages darwin universal binary (arm64 + amd64)
+ summary: |
+ Packages darwin universal binary (arm64 + amd64)
+ Output: ./build/bin/MyApp.app
deps:
- darwin:build:universal
cmds:
- task: darwin:create:app:bundle
+ - codesign --verify --verbose ./build/bin/MyApp.app || true
+ status:
+ - test -d ./build/bin/MyApp.appLet's verify the app bundle creation task exists:
|
Thanks for opening this. Did you mean to add this to the file-association example or did you mean to have it in the default templates? |
I realized I missed pushing the changes for the default templates, thanks for catching that! |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
v3/internal/templates/_common/Taskfile.tmpl.yml (2)
35-47: Consider adding error handling and environment checksWhile the universal build task is well-structured, there are a few improvements that could make it more robust:
- The task should verify the availability of the
lipocommand before proceeding- Consider adding error handling for failed intermediate builds
- The intermediate file cleanup could fail silently if files don't exist
Here's a suggested improvement:
darwin:build:universal: summary: Builds darwin universal binary (arm64 + amd64) + preconditions: + - sh: command -v lipo + msg: "lipo command is required for universal builds" cmds: - task: darwin:build vars: ARCH: amd64 - mv {{ "{{.BIN_DIR}}/{{.APP_NAME}}" }} {{ "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" }} - task: darwin:build vars: ARCH: arm64 - mv {{ "{{.BIN_DIR}}/{{.APP_NAME}}" }} {{ "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" }} - lipo -create -output {{ "{{.BIN_DIR}}/{{.APP_NAME}}" }} {{ "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" }} {{ "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" }} - - rm {{ "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" }} {{ "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" }} + - rm -f {{ "{{.BIN_DIR}}/{{.APP_NAME}}-amd64" }} {{ "{{.BIN_DIR}}/{{.APP_NAME}}-arm64" }}
34-54: Consider documenting the universal build featureSince this is a new feature for v3 alpha, consider:
- Adding comments in the Taskfile explaining the universal build process
- Updating the project documentation to cover this new build capability
- Including example usage in the README or relevant docs
Consider adding these comments above the tasks:
+# Universal build tasks for Darwin (macOS) +# Builds both arm64 and amd64 architectures and combines them using lipo +# Requirements: +# - lipo command (part of Xcode command line tools) +# - Sufficient disk space for both architecture builds darwin:build:universal:
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
v3/internal/templates/_common/Taskfile.tmpl.yml(1 hunks)
🔇 Additional comments (1)
v3/internal/templates/_common/Taskfile.tmpl.yml (1)
49-54: Verify the existence of dependent tasks
The task depends on darwin:create:app:bundle which should be defined in the included ./build/Taskfile.darwin.yml.
Let's verify the task dependencies:
✅ Verification successful
Dependencies verified and found to be correctly defined
The task dependencies are properly defined and implemented:
darwin:create:app:bundletask exists in the included darwin Taskfile (build/Taskfile.darwin.yml) as shown in the example implementationdarwin:build:universaltask is defined in the same file and correctly builds both architectures- The task chain and implementation follows the expected pattern seen in the example
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if the required darwin tasks exist in the included files
# Check for the darwin:create:app:bundle task
rg -l "darwin:create:app:bundle" build/Taskfile.darwin.yml
# Check for any potential naming inconsistencies
rg -l "create:app:bundle|create-app-bundle|createAppBundle" build/
Length of output: 240
Script:
#!/bin/bash
# Let's first check where the Taskfile is located and find related task files
fd -t f "Taskfile.*yml"
# Then search for the specific task names in all yml files
rg -l "darwin:create:app:bundle|darwin:build:universal"
Length of output: 917
Script:
#!/bin/bash
# Let's check the content of both files to understand the task definitions
echo "=== Content of v3/internal/templates/_common/Taskfile.tmpl.yml ==="
cat v3/internal/templates/_common/Taskfile.tmpl.yml
echo -e "\n=== Content of v3/examples/file-association/Taskfile.yml ==="
cat v3/examples/file-association/Taskfile.yml
# Also check related darwin build files in these directories
echo -e "\n=== Checking darwin-related files in file-association example ==="
cat v3/examples/file-association/build/Taskfile.darwin.yml
Length of output: 4965
Description
Added support for darwin universal build and package
Type of change
Please select the option that is relevant.
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.If you checked Linux, please specify the distro and version.
Test Configuration
Please paste the output of
wails3 doctor. If you are unable to run this command, please describe your environment in as much detail as possible.Checklist:
website/src/pages/changelog.mdxwith details of this PRSummary by CodeRabbit
New Features
Bug Fixes
Documentation