bundle

  1#!/bin/bash
  2
  3set -e
  4
  5build_flag="--release"
  6target_dir="release"
  7open_result=false
  8local_arch=false
  9local_only=false
 10overwrite_local_app=false
 11bundle_name=""
 12zed_crate="zed"
 13binary_name="Zed"
 14
 15# This must match the team in the provsiioning profile.
 16APPLE_NOTORIZATION_TEAM="MQ55VZLNZQ"
 17
 18# Function for displaying help info
 19help_info() {
 20  echo "
 21Usage: ${0##*/} [options] [bundle_name]
 22Build the application bundle.
 23
 24Options:
 25  -d    Compile in debug mode
 26  -l    Compile for local architecture and copy bundle to /Applications, implies -d.
 27  -o    Open the resulting DMG or the app itself in local mode.
 28  -f    Overwrite the local app bundle if it exists.
 29  -h    Display this help and exit.
 30  "
 31}
 32
 33while getopts 'dlfoh' flag
 34do
 35    case "${flag}" in
 36        o) open_result=true;;
 37        d)
 38            export CARGO_INCREMENTAL=true
 39            export CARGO_BUNDLE_SKIP_BUILD=true
 40            build_flag="";
 41            target_dir="debug"
 42            ;;
 43        l)
 44            export CARGO_INCREMENTAL=true
 45            export CARGO_BUNDLE_SKIP_BUILD=true
 46            build_flag=""
 47            local_arch=true
 48            local_only=true
 49            target_dir="debug"
 50            ;;
 51        f) overwrite_local_app=true;;
 52        h)
 53           help_info
 54           exit 0
 55           ;;
 56    esac
 57done
 58
 59shift $((OPTIND-1))
 60
 61if [ "$1" ]; then
 62    bundle_name=$1
 63fi
 64
 65export ZED_BUNDLE=true
 66export MACOSX_DEPLOYMENT_TARGET=10.15.7
 67
 68cargo_bundle_version=$(cargo -q bundle --help 2>&1 | head -n 1 || echo "")
 69if [ "$cargo_bundle_version" != "cargo-bundle v0.6.0-zed" ]; then
 70    cargo install cargo-bundle --git https://github.com/zed-industries/cargo-bundle.git --branch zed-deploy
 71fi
 72
 73rustup target add wasm32-wasi
 74
 75# Deal with versions of macOS that don't include libstdc++ headers
 76export CXXFLAGS="-stdlib=libc++"
 77
 78version_info=$(rustc --version --verbose)
 79host_line=$(echo "$version_info" | grep host)
 80local_target_triple=${host_line#*: }
 81
 82if [ -z "$ZED_CLIENT_CHECKSUM_SEED" ]; then
 83    echo "Missing ZED_CLIENT_CHECKSUM_SEED environment variable"
 84    exit 1
 85fi
 86
 87if [ "$local_arch" = true ]; then
 88    echo "Building for local target only."
 89    cargo build ${build_flag} --package ${zed_crate}
 90    cargo build ${build_flag} --package cli
 91else
 92    echo "Compiling zed binaries"
 93    cargo build ${build_flag} --package ${zed_crate} --package cli --target aarch64-apple-darwin --target x86_64-apple-darwin
 94fi
 95
 96echo "Creating application bundle"
 97pushd crates/zed
 98channel=$(<RELEASE_CHANNEL)
 99popd
100
101pushd crates/${zed_crate}
102cp Cargo.toml Cargo.toml.backup
103sed \
104    -i .backup \
105    "s/package.metadata.bundle-${channel}/package.metadata.bundle/" \
106    Cargo.toml
107
108if [ "$local_arch" = true ]; then
109    app_path=$(cargo bundle ${build_flag} --select-workspace-root | xargs)
110else
111    app_path=$(cargo bundle ${build_flag} --target x86_64-apple-darwin --select-workspace-root | xargs)
112fi
113
114mv Cargo.toml.backup Cargo.toml
115popd
116echo "Bundled ${app_path}"
117
118if [ "$local_arch" = false ]; then
119    echo "Creating fat binaries"
120    lipo \
121        -create \
122        target/{x86_64-apple-darwin,aarch64-apple-darwin}/${target_dir}/${binary_name} \
123        -output \
124        "${app_path}/Contents/MacOS/${zed_crate}"
125    lipo \
126        -create \
127        target/{x86_64-apple-darwin,aarch64-apple-darwin}/${target_dir}/cli \
128        -output \
129        "${app_path}/Contents/MacOS/cli"
130fi
131
132echo "Copying WebRTC.framework into the frameworks folder"
133mkdir "${app_path}/Contents/Frameworks"
134if [ "$local_arch" = false ]; then
135    cp -R target/${local_target_triple}/${target_dir}/WebRTC.framework "${app_path}/Contents/Frameworks/"
136else
137    cp -R target/${target_dir}/WebRTC.framework "${app_path}/Contents/Frameworks/"
138fi
139
140# Note: The app identifier for our development builds is the same as the app identifier for nightly.
141cp crates/${zed_crate}/contents/$channel/embedded.provisionprofile "${app_path}/Contents/"
142
143if [[ -n $MACOS_CERTIFICATE && -n $MACOS_CERTIFICATE_PASSWORD && -n $APPLE_NOTARIZATION_USERNAME && -n $APPLE_NOTARIZATION_PASSWORD ]]; then
144    echo "Signing bundle with Apple-issued certificate"
145    security create-keychain -p "$MACOS_CERTIFICATE_PASSWORD" zed.keychain || echo ""
146    security default-keychain -s zed.keychain
147    security unlock-keychain -p "$MACOS_CERTIFICATE_PASSWORD" zed.keychain
148    echo "$MACOS_CERTIFICATE" | base64 --decode > /tmp/zed-certificate.p12
149    security import /tmp/zed-certificate.p12 -k zed.keychain -P "$MACOS_CERTIFICATE_PASSWORD" -T /usr/bin/codesign
150    rm /tmp/zed-certificate.p12
151    security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k "$MACOS_CERTIFICATE_PASSWORD" zed.keychain
152
153    # sequence of codesign commands modeled after this example: https://developer.apple.com/forums/thread/701514
154    /usr/bin/codesign --deep --force --timestamp --sign "Zed Industries, Inc." "${app_path}/Contents/Frameworks/WebRTC.framework" -v
155    /usr/bin/codesign --deep --force --timestamp --options runtime --sign "Zed Industries, Inc." "${app_path}/Contents/MacOS/cli" -v
156    /usr/bin/codesign --deep --force --timestamp --options runtime --entitlements crates/${zed_crate}/resources/zed.entitlements --sign "Zed Industries, Inc." "${app_path}/Contents/MacOS/${zed_crate}" -v
157    /usr/bin/codesign --force --timestamp --options runtime --entitlements crates/${zed_crate}/resources/zed.entitlements --sign "Zed Industries, Inc." "${app_path}" -v
158
159    security default-keychain -s login.keychain
160else
161    echo "One or more of the following variables are missing: MACOS_CERTIFICATE, MACOS_CERTIFICATE_PASSWORD, APPLE_NOTARIZATION_USERNAME, APPLE_NOTARIZATION_PASSWORD"
162    if [[ "$local_only" = false ]]; then
163        echo "To create a self-signed local build use ./scripts/build.sh -ldf"
164        exit 1
165    fi
166
167    echo "====== WARNING ======"
168    echo "This bundle is being signed without all entitlements, some features (e.g. universal links) will not work"
169    echo "====== WARNING ======"
170
171    # NOTE: if you need to test universal links you have a few paths forward:
172    # - create a PR and tag it with the `run-build-dmg` label, and download the .dmg file from there.
173    # - get a signing key for the MQ55VZLNZQ team from Nathan.
174    # - create your own signing key, and update references to MQ55VZLNZQ to your own team ID
175    # then comment out this line.
176    cat crates/${zed_crate}/resources/zed.entitlements | sed '/com.apple.developer.associated-domains/,+1d' > "${app_path}/Contents/Resources/zed.entitlements"
177
178    codesign --force --deep --entitlements "${app_path}/Contents/Resources/zed.entitlements" --sign ${MACOS_SIGNING_KEY:- -} "${app_path}" -v
179fi
180
181if [[ "$target_dir" = "debug" && "$local_only" = false ]]; then
182    if [ "$open_result" = true ]; then
183        open "$app_path"
184    else
185        echo "Created application bundle:"
186        echo "$app_path"
187    fi
188    exit 0
189fi
190
191if [ "$local_only" = true ]; then
192    # If bundle_name is not set or empty, use the basename of $app_path
193    if [ -z "$bundle_name" ]; then
194        bundle_name=$(basename "$app_path")
195    else
196        # If bundle_name doesn't end in .app, append it
197        if [[ "$bundle_name" != *.app ]]; then
198            bundle_name="$bundle_name.app"
199        fi
200    fi
201
202    if [ "$overwrite_local_app" = true ]; then
203        rm -rf "/Applications/$bundle_name"
204    fi
205    mv "$app_path" "/Applications/$bundle_name"
206
207    if [ "$open_result" = true ]; then
208        open "/Applications/$bundle_name"
209    else
210        echo "Installed application bundle:"
211        echo "/Applications/$bundle_name"
212    fi
213else
214    echo "Creating DMG"
215    dmg_target_directory="target/${target_dir}"
216    dmg_source_directory="${dmg_target_directory}/dmg"
217    dmg_file_path="${dmg_target_directory}/Zed.dmg"
218
219    rm -rf ${dmg_source_directory}
220    mkdir -p ${dmg_source_directory}
221    mv "${app_path}" "${dmg_source_directory}"
222
223    ln -s /Applications ${dmg_source_directory}
224    hdiutil create -volname Zed -srcfolder "${dmg_source_directory}" -ov -format UDZO "${dmg_file_path}"
225    # If someone runs this bundle script locally, a symlink will be placed in `dmg_source_directory`.
226    # This symlink causes CPU issues with Zed if the Zed codebase is the project being worked on, so we simply remove it for now.
227    rm ${dmg_source_directory}/Applications
228
229    echo "Adding license agreement to DMG"
230    npm install --global dmg-license minimist
231    dmg-license script/eula/eula.json "${dmg_file_path}"
232
233    if [[ -n $MACOS_CERTIFICATE && -n $MACOS_CERTIFICATE_PASSWORD && -n $APPLE_NOTARIZATION_USERNAME && -n $APPLE_NOTARIZATION_PASSWORD ]]; then
234        echo "Notarizing DMG with Apple"
235        "$(xcode-select -p)/usr/bin/notarytool" submit --wait --apple-id "$APPLE_NOTARIZATION_USERNAME" --password "$APPLE_NOTARIZATION_PASSWORD" --team-id "$APPLE_NOTORIZATION_TEAM" "${dmg_file_path}"
236    fi
237
238    if [ "$open_result" = true ]; then
239        open $dmg_target_directory
240    fi
241fi