summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorDavid Lönnhager <david.l@mullvad.net>2020-01-20 10:01:30 +0100
committerDavid Lönnhager <david.l@mullvad.net>2020-01-22 13:44:27 +0100
commit7aa2d778c78802bfa6c3b91ade6bdf832b6f9893 (patch)
tree35619e44cd3fd216f8e03a7b47f76538d0f7bef6
parent784fba2393a9db79ea21bed86e67317fe076e360 (diff)
downloadmullvadvpn-7aa2d778c78802bfa6c3b91ade6bdf832b6f9893.tar.xz
mullvadvpn-7aa2d778c78802bfa6c3b91ade6bdf832b6f9893.zip
Update README.md
-rw-r--r--README.md41
1 files changed, 22 insertions, 19 deletions
diff --git a/README.md b/README.md
index 7746253fe5..f3600e39b5 100644
--- a/README.md
+++ b/README.md
@@ -368,27 +368,30 @@ the version of the app you are going to release. For example `2018.3-beta1` or `
Please verify that the script did the right thing before you push the commit and tag it created.
-1. When building for macOS, the following environment variables must be set:
- * `CSC_LINK` - The path to the `.p12` certificate file with the Apple application signing keys.
- This file must contain both the "Developer ID Application" and the "Developer ID Installer"
- certificates + private keys. If this environment variable is missing `build.sh` will skip
- signing.
+1. When building for Windows or macOS, the following environment variables must be set:
+ * `CSC_LINK` - The path to the certificate used for code signing.
+ * Windows: A `.pfx` certificate.
+ * macOS: A `.p12` certificate file with the Apple application signing keys.
+ This file must contain both the "Developer ID Application" and the "Developer ID Installer"
+ certificates + private keys.
* `CSC_KEY_PASSWORD` - The password to the file given in `CSC_LINK`. If this is not set then
- `build.sh` will prompt you for it. If you set it yourself, make sure to define it in such a
- way that it's not stored in your bash history:
- ```bash
- export HISTCONTROL=ignorespace
- export CSC_KEY_PASSWORD='my secret'
- ```
- * `NOTARIZE_APPLE_ID` - The AppleId to use when notarizing the app. Only needed on release builds
- * `NOTARIZE_APPLE_ID_PASSWORD` - The AppleId password for the account in `NOTARIZE_APPLE_ID`.
- Don't use the real AppleId password! Instead create an app specific password and add that to
- your keyring. See this documentation: https://github.com/electron/electron-notarize#safety-when-using-appleidpassword
+ `build.sh` will prompt you for it. If you set it yourself, make sure to define it in such a
+ way that it's not stored in your bash history:
+ ```bash
+ export HISTCONTROL=ignorespace
+ export CSC_KEY_PASSWORD='my secret'
+ ```
- Summary:
- 1. Generate app specific password on Apple's AppleId management portal.
- 2. Run `security add-generic-password -a "<apple_id>" -w <app_specific_password> -s "something_something"`
- 3. Set `NOTARIZE_APPLE_ID_PASSWORD="@keychain:something_something"`.
+ * *macOS only*:
+ * `NOTARIZE_APPLE_ID` - The AppleId to use when notarizing the app. Only needed on release builds
+ * `NOTARIZE_APPLE_ID_PASSWORD` - The AppleId password for the account in `NOTARIZE_APPLE_ID`.
+ Don't use the real AppleId password! Instead create an app specific password and add that to
+ your keyring. See this documentation: https://github.com/electron/electron-notarize#safety-when-using-appleidpassword
+
+ Summary:
+ 1. Generate app specific password on Apple's AppleId management portal.
+ 2. Run `security add-generic-password -a "<apple_id>" -w <app_specific_password> -s "something_something"`
+ 3. Set `NOTARIZE_APPLE_ID_PASSWORD="@keychain:something_something"`.
1. Run `./build.sh` on each computer/platform where you want to create a release artifact. This will
do the following for you: