Merge pull request #3117 from ggamel/patch-1

Update MAS tutorial to improve readability
This commit is contained in:
Jessica Lord 2015-10-16 17:56:32 -07:00
commit cd2f924db8

View file

@ -1,29 +1,29 @@
# Mac App Store Submission Guide # Mac App Store Submission Guide
Since v0.34.0, Electron allows submitting packaged apps to Mac App Store (MAS), Since v0.34.0, Electron allows submitting packaged apps to the Mac App Store
this guide provides information on how to submit your app, and the limitations (MAS). This guide provides information on: how to submit your app and the
of the MAS build. limitations of the MAS build.
## How to submit your app ## How to Submit Your App
Following steps introduces a simple way to submit your app to Mac App Store, but The following steps introduce a simple way to submit your app to Mac App Store.
it doesn't make sure your app gets approved by Apple, you still have to read However, these steps do not ensure sure your app will be approved by Apple; you
apple's [Submitting Your App][submitting-your-app] guide on how to meet Mac still need to read Apple's [Submitting Your App][submitting-your-app] guide on
App Store's requirements. how to meet the Mac App Store requirements.
### Get certificate ### Get Certificate
To submit your app to Mac App Store, you have to get a certificate from Apple To submit your app to the Mac App Store, you first must get a certificate from
first, you can follow [existing guides][nwjs-guide] on web. Apple. You can follow these [existing guides][nwjs-guide] on web.
### Sign your app ### Sign Your App
After getting the certificate, you can package your app by following After getting the certificate from Apple, you can package your app by following
[Application Distribution](application-distribution.md), and then sign your app. [Application Distribution](application-distribution.md), and then proceed to
The step is basically the same with other programs, the key is to sign every signing your app. This step is basically the same with other programs, but the
dependency of Electron one by one. key is to sign every dependency of Electron one by one.
First you need to prepare two entitlements files. First, you need to prepare two entitlements files.
`child.plist`: `child.plist`:
@ -53,7 +53,7 @@ First you need to prepare two entitlements files.
</plist> </plist>
``` ```
And then sign your app with following script: And then sign your app with the following script:
```bash ```bash
#!/bin/bash #!/bin/bash
@ -79,33 +79,34 @@ codesign --deep -fs "$APP_KEY" --entitlements child.plist "$FRAMEWORKS_PATH/$APP
codesign -fs "$APP_KEY" --entitlements parent.plist "$APP_PATH" codesign -fs "$APP_KEY" --entitlements parent.plist "$APP_PATH"
productbuild --component "$APP_PATH" /Applications --sign "$INSTALLER_KEY" "$APP_PATH" productbuild --component "$APP_PATH" /Applications --sign "$INSTALLER_KEY" "$APP_PATH"
``` ```
a
If you are new to app sandboxing under OS X, you should also read through
Apple's [Enabling App Sandbox][enable-app-sandbox] to have a basic idea, then
add keys for the permissions needed by your app to the entitlements files.
If you are new to app sandboxing of OS X, you should also go through Apple's ### Upload Your App and Submit for Review
[Enabling App Sandbox][enable-app-sandbox] to have a basic idea, and add keys
for the permissions needed by your app to the entitlements files.
### Upload your app and submit for review After signing your app, you can use Application Loader to upload it to iTunes
Connect for processing, making sure you have [created a record][create-record]
After signing your app you can use Application Loader to upload it to iTunes
Connect for processing, make sure you have [created a record][create-record]
before uploading. Then you can [submit your app for review][submit-for-review]. before uploading. Then you can [submit your app for review][submit-for-review].
## Limitations of MAS build ## Limitations of MAS Build
In order to satisfy requirements for app sandboxing, following modules have been In order to satisfy all requirements for app sandboxing, the following modules
disabled in MAS build: have been disabled in the MAS build:
* `crash-reporter` * `crash-reporter`
* `auto-updater` * `auto-updater`
and following behaviors have been changed: and the following behaviors have been changed:
* Video capture may not work for some machines. * Video capture may not work for some machines.
* Certain accessibility features may not work. * Certain accessibility features may not work.
* Apps will not be aware of DNS changes. * Apps will not be aware of DNS changes.
Also due to the usage of app sandboxing, the resources can be accessed by the Also, due to the usage of app sandboxing, the resources which can be accessed by
app is strictly limited, you can read [App Sandboxing][app-sandboxing] for more. the app are strictly limited; you can read [App Sandboxing][app-sandboxing] for
more information.
[submitting-your-app]: https://developer.apple.com/library/mac/documentation/IDEs/Conceptual/AppDistributionGuide/SubmittingYourApp/SubmittingYourApp.html [submitting-your-app]: https://developer.apple.com/library/mac/documentation/IDEs/Conceptual/AppDistributionGuide/SubmittingYourApp/SubmittingYourApp.html
[nwjs-guide]: https://github.com/nwjs/nw.js/wiki/Mac-App-Store-%28MAS%29-Submission-Guideline#first-steps [nwjs-guide]: https://github.com/nwjs/nw.js/wiki/Mac-App-Store-%28MAS%29-Submission-Guideline#first-steps