Update Mac AppStore Guide to support app names containing spaces#3923
Conversation
WalkthroughThe pull request includes updates to the documentation for submitting Wails Apps to the Mac App Store, enhancing clarity and precision in the instructions. Key modifications involve detailed steps for creating certificates, identifiers, and provisioning profiles. The document also clarifies the App Sandbox process and refines build and signing instructions. Additionally, the changelog has been updated to reflect various modifications, including bug fixes and new features, such as the ability to set the minimum macOS version externally and support for application names with spaces. 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
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
website/docs/guides/mac-appstore.mdx (1)
84-86: Consider enhancing the script with error handling and consistencyWhile the current changes fix the spaces issue, the script could benefit from additional improvements:
#!/bin/bash +# Exit on error +set -e + APP_CERTIFICATE="3rd Party Mac Developer Application: YOUR NAME (CODE)" PKG_CERTIFICATE="3rd Party Mac Developer Installer: YOUR NAME (CODE)" APP_NAME="YourApp" +# Validate required variables +if [ -z "$APP_NAME" ] || [ -z "$APP_CERTIFICATE" ] || [ -z "$PKG_CERTIFICATE" ]; then + echo "Error: Required variables not set" + exit 1 +fi + wails build -platform darwin/universal -clean -cp ./embedded.provisionprofile "./build/bin/$APP_NAME.app/Contents" +cp "./embedded.provisionprofile" "./build/bin/$APP_NAME.app/Contents/" codesign --timestamp --options=runtime -s "$APP_CERTIFICATE" -v --entitlements ./build/darwin/entitlements.plist "./build/bin/$APP_NAME.app" productbuild --sign "$PKG_CERTIFICATE" --component "./build/bin/$APP_NAME.app" /Applications "./$APP_NAME.pkg" + +echo "Build completed successfully!"These improvements:
- Add error handling with
set -e- Validate required variables
- Add quotes to the
cpcommand for consistency- Add a success message
website/src/pages/changelog.mdx (2)
Line range hint
18-24: Consider adding version comparison linksTo make it easier for users to compare versions, consider adding version comparison links at the bottom of each version entry, e.g.:
+ [v2.0.0]: https://github.com/wailsapp/wails/compare/v2.0.0-rc.1...v2.0.0🧰 Tools
🪛 LanguageTool
[duplication] ~20-~20: Possible typo: you repeated a word
Context: ...pport app names containing spaces. ### Added - Added option to set window class name on Wind...(ENGLISH_WORD_REPEAT_RULE)
Line range hint
1-1500: Consider adding migration guides for breaking changesWhen documenting breaking changes, consider adding links to migration guides to help users upgrade smoothly. For example, in the v2.0.0-beta.44 entry where CSS drag detection was introduced.
🧰 Tools
🪛 LanguageTool
[duplication] ~20-~20: Possible typo: you repeated a word
Context: ...pport app names containing spaces. ### Added - Added option to set window class name on Wind...(ENGLISH_WORD_REPEAT_RULE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
website/docs/guides/mac-appstore.mdx(1 hunks)website/src/pages/changelog.mdx(1 hunks)
🔇 Additional comments (2)
website/docs/guides/mac-appstore.mdx (1)
84-84: LGTM! Proper handling of paths with spaces
The addition of quotes around file paths in the codesign and productbuild commands correctly addresses the issue of handling app names containing spaces.
Also applies to: 86-86
website/src/pages/changelog.mdx (1)
Line range hint 1-24: LGTM! The changelog follows best practices.
The changelog follows the Keep a Changelog format and provides clear categorization of changes. The format is consistent and well-structured.
🧰 Tools
🪛 LanguageTool
[duplication] ~20-~20: Possible typo: you repeated a word
Context: ...pport app names containing spaces. ### Added - Added option to set window class name on Wind...
(ENGLISH_WORD_REPEAT_RULE)
|
Thanks for doing this. Can you please add a link to your GH Profile so the changeling properly credits you. Thanks! 🙏 |
|
No problem, done |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
website/src/pages/changelog.mdx (1)
Line range hint
1-1979: LGTM! The changelog is well-maintained and follows good practices.The changelog follows a clear and consistent format, with proper categorization of changes and attribution to contributors. The entries are ordered chronologically with the most recent changes at the top.
Consider adding more metadata to version entries
While the current format is good, consider enhancing it with:
- Release dates in ISO 8601 format (YYYY-MM-DD)
- Links to related PRs/issues consistently for all entries
- Type of release (e.g. Feature, Bug fix, etc.)
Example format:
## [v2.0.0] - 2024-09-22 (Feature Release) ### Added - Feature X (#123) @contributor🧰 Tools
🪛 LanguageTool
[duplication] ~20-~20: Possible typo: you repeated a word
Context: ...ntaining spaces by @cristianrgreco ### Added - Added option to set window class name on Wind...(ENGLISH_WORD_REPEAT_RULE)
|
Thanks for taking the time to do this 🙏 |
Description
The script in the Mac App Store guide doesn't work for an app name containing spaces. This fix simply wraps arguments containing the app name in quotes.
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
wails 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
go-webview2to fix a nativewebview2loaderissue.WindowSetSize.Documentation