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