1#!/usr/bin/env bash
2
3set -euo pipefail
4source script/lib/blob-store.sh
5
6build_flag="--release"
7target_dir="release"
8open_result=false
9local_arch=false
10local_only=false
11local_install=false
12bundle_name=""
13can_code_sign=false
14
15# This must match the team in the provisioning profile.
16IDENTITY="Zed Industries, Inc."
17APPLE_NOTORIZATION_TEAM="MQ55VZLNZQ"
18
19# Function for displaying help info
20help_info() {
21 echo "
22Usage: ${0##*/} [options] [bundle_name]
23Build the application bundle for macOS.
24
25Options:
26 -d Compile in debug mode
27 -l Compile for local architecture and copy bundle to /Applications.
28 -o Open dir with the resulting DMG or launch the app itself in local mode.
29 -i Install the resulting DMG into /Applications in local mode. Noop without -l.
30 -h Display this help and exit.
31 "
32}
33
34while getopts 'dloih' flag
35do
36 case "${flag}" in
37 o) open_result=true;;
38 d)
39 export CARGO_INCREMENTAL=true
40 export CARGO_BUNDLE_SKIP_BUILD=true
41 build_flag="";
42 target_dir="debug"
43 ;;
44 l)
45 export CARGO_INCREMENTAL=true
46 export CARGO_BUNDLE_SKIP_BUILD=true
47 local_arch=true
48 local_only=true
49 ;;
50 i) local_install=true;;
51 h)
52 help_info
53 exit 0
54 ;;
55 esac
56done
57
58shift $((OPTIND-1))
59
60if [[ $# -gt 0 ]]; then
61 if [ "$1" ]; then
62 bundle_name=$1
63 fi
64fi
65
66export ZED_BUNDLE=true
67export MACOSX_DEPLOYMENT_TARGET=10.15.7
68
69cargo_bundle_version=$(cargo -q bundle --help 2>&1 | head -n 1 || echo "")
70if [ "$cargo_bundle_version" != "cargo-bundle v0.6.0-zed" ]; then
71 cargo install cargo-bundle --git https://github.com/zed-industries/cargo-bundle.git --branch zed-deploy
72fi
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 --package cli --package remote_server
84else
85 echo "Compiling zed binaries"
86 cargo build ${build_flag} --package zed --package cli --package remote_server --target aarch64-apple-darwin --target x86_64-apple-darwin
87fi
88
89echo "Creating application bundle"
90pushd crates/zed
91channel=$(<RELEASE_CHANNEL)
92popd
93
94pushd crates/zed
95cp Cargo.toml Cargo.toml.backup
96sed \
97 -i .backup \
98 "s/package.metadata.bundle-${channel}/package.metadata.bundle/" \
99 Cargo.toml
100
101if [ "$local_arch" = true ]; then
102 app_path=$(cargo bundle ${build_flag} --select-workspace-root | xargs)
103else
104 app_path_x64=$(cargo bundle ${build_flag} --target x86_64-apple-darwin --select-workspace-root | xargs)
105 app_path_aarch64=$(cargo bundle ${build_flag} --target aarch64-apple-darwin --select-workspace-root | xargs)
106 app_path=$app_path_x64
107fi
108
109mv Cargo.toml.backup Cargo.toml
110popd
111echo "Bundled ${app_path}"
112
113if [[ -n "${MACOS_CERTIFICATE:-}" && -n "${MACOS_CERTIFICATE_PASSWORD:-}" && -n "${APPLE_NOTARIZATION_USERNAME:-}" && -n "${APPLE_NOTARIZATION_PASSWORD:-}" ]]; then
114 can_code_sign=true
115
116 echo "Setting up keychain for code signing..."
117 security create-keychain -p "$MACOS_CERTIFICATE_PASSWORD" zed.keychain || echo ""
118 security default-keychain -s zed.keychain
119 security unlock-keychain -p "$MACOS_CERTIFICATE_PASSWORD" zed.keychain
120 echo "$MACOS_CERTIFICATE" | base64 --decode > /tmp/zed-certificate.p12
121 security import /tmp/zed-certificate.p12 -k zed.keychain -P "$MACOS_CERTIFICATE_PASSWORD" -T /usr/bin/codesign
122 rm /tmp/zed-certificate.p12
123 security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k "$MACOS_CERTIFICATE_PASSWORD" zed.keychain
124
125 function cleanup() {
126 echo "Cleaning up keychain"
127 security default-keychain -s login.keychain
128 security delete-keychain zed.keychain
129 }
130
131 trap cleanup EXIT
132fi
133
134GIT_VERSION="v2.43.3"
135GIT_VERSION_SHA="fa29823"
136
137function download_and_unpack() {
138 local url=$1
139 local path_to_unpack=$2
140 local target_path=$3
141
142 temp_dir=$(mktemp -d)
143
144 if ! command -v curl &> /dev/null; then
145 echo "curl is not installed. Please install curl to continue."
146 exit 1
147 fi
148
149 curl --silent --fail --location "$url" | tar -xvz -C "$temp_dir" -f - $path_to_unpack
150
151 mv "$temp_dir/$path_to_unpack" "$target_path"
152
153 rm -rf "$temp_dir"
154}
155
156function download_git() {
157 local architecture=$1
158 local target_binary=$2
159
160 tmp_dir=$(mktemp -d)
161 pushd "$tmp_dir"
162
163 case "$architecture" in
164 aarch64-apple-darwin)
165 download_and_unpack "https://github.com/desktop/dugite-native/releases/download/${GIT_VERSION}/dugite-native-${GIT_VERSION}-${GIT_VERSION_SHA}-macOS-arm64.tar.gz" bin/git ./git
166 ;;
167 x86_64-apple-darwin)
168 download_and_unpack "https://github.com/desktop/dugite-native/releases/download/${GIT_VERSION}/dugite-native-${GIT_VERSION}-${GIT_VERSION_SHA}-macOS-x64.tar.gz" bin/git ./git
169 ;;
170 universal)
171 download_and_unpack "https://github.com/desktop/dugite-native/releases/download/${GIT_VERSION}/dugite-native-${GIT_VERSION}-${GIT_VERSION_SHA}-macOS-arm64.tar.gz" bin/git ./git_arm64
172 download_and_unpack "https://github.com/desktop/dugite-native/releases/download/${GIT_VERSION}/dugite-native-${GIT_VERSION}-${GIT_VERSION_SHA}-macOS-x64.tar.gz" bin/git ./git_x64
173 lipo -create ./git_arm64 ./git_x64 -output ./git
174 ;;
175 *)
176 echo "Unsupported architecture: $architecture"
177 exit 1
178 ;;
179 esac
180
181 popd
182
183 mv "${tmp_dir}/git" "${target_binary}"
184 rm -rf "$tmp_dir"
185}
186
187function prepare_binaries() {
188 local architecture=$1
189 local app_path=$2
190
191 echo "Unpacking dSYMs for $ architecture"
192 dsymutil --flat target/${architecture}/${target_dir}/Zed
193 version="$(cargo metadata --no-deps --manifest-path crates/zed/Cargo.toml --offline --format-version=1 | jq -r '.packages | map(select(.name == "zed"))[0].version')"
194 if [ "$channel" == "nightly" ]; then
195 version="$version-$(git rev-parse --short HEAD)"
196 fi
197
198 echo "Removing existing gzipped dSYMs for $architecture"
199 rm -f target/${architecture}/${target_dir}/Zed.dwarf.gz
200
201 echo "Gzipping dSYMs for $architecture"
202 gzip target/${architecture}/${target_dir}/Zed.dwarf
203
204 echo "Uploading dSYMs for $architecture"
205 upload_to_blob_store_public \
206 "zed-debug-symbols" \
207 target/${architecture}/${target_dir}/Zed.dwarf.gz \
208 "$channel/Zed-$version-${architecture}.dwarf.gz"
209
210 cp target/${architecture}/${target_dir}/zed "${app_path}/Contents/MacOS/zed"
211 cp target/${architecture}/${target_dir}/cli "${app_path}/Contents/MacOS/cli"
212}
213
214function sign_app_binaries() {
215 local app_path=$1
216 local architecture=$2
217 local architecture_dir=$3
218 echo "Copying WebRTC.framework into the frameworks folder"
219 mkdir "${app_path}/Contents/Frameworks"
220 if [ "$local_arch" = false ]; then
221 cp -R target/${local_target_triple}/${target_dir}/WebRTC.framework "${app_path}/Contents/Frameworks/"
222 else
223 cp -R target/${target_dir}/WebRTC.framework "${app_path}/Contents/Frameworks/"
224 cp -R target/${target_dir}/cli "${app_path}/Contents/MacOS/"
225 fi
226
227 echo "Downloading git binary"
228 download_git "${architecture}" "${app_path}/Contents/MacOS/git"
229
230 # Note: The app identifier for our development builds is the same as the app identifier for nightly.
231 cp crates/zed/contents/$channel/embedded.provisionprofile "${app_path}/Contents/"
232
233 if [[ $can_code_sign = true ]]; then
234 echo "Code signing binaries"
235 # sequence of codesign commands modeled after this example: https://developer.apple.com/forums/thread/701514
236 /usr/bin/codesign --deep --force --timestamp --sign "$IDENTITY" "${app_path}/Contents/Frameworks/WebRTC.framework" -v
237 /usr/bin/codesign --deep --force --timestamp --options runtime --sign "$IDENTITY" "${app_path}/Contents/MacOS/cli" -v
238 /usr/bin/codesign --deep --force --timestamp --options runtime --sign "$IDENTITY" "${app_path}/Contents/MacOS/git" -v
239 /usr/bin/codesign --deep --force --timestamp --options runtime --entitlements crates/zed/resources/zed.entitlements --sign "$IDENTITY" "${app_path}/Contents/MacOS/zed" -v
240 /usr/bin/codesign --force --timestamp --options runtime --entitlements crates/zed/resources/zed.entitlements --sign "$IDENTITY" "${app_path}" -v
241 else
242 echo "One or more of the following variables are missing: MACOS_CERTIFICATE, MACOS_CERTIFICATE_PASSWORD, APPLE_NOTARIZATION_USERNAME, APPLE_NOTARIZATION_PASSWORD"
243 if [[ "$local_only" = false ]]; then
244 echo "To create a self-signed local build use ./scripts/build.sh -ldf"
245 exit 1
246 fi
247
248 echo "====== WARNING ======"
249 echo "This bundle is being signed without all entitlements, some features (e.g. universal links) will not work"
250 echo "====== WARNING ======"
251
252 # NOTE: if you need to test universal links you have a few paths forward:
253 # - create a PR and tag it with the `run-bundling` label, and download the .dmg file from there.
254 # - get a signing key for the MQ55VZLNZQ team from Nathan.
255 # - create your own signing key, and update references to MQ55VZLNZQ to your own team ID
256 # then comment out this line.
257 cat crates/zed/resources/zed.entitlements | sed '/com.apple.developer.associated-domains/,+1d' > "${app_path}/Contents/Resources/zed.entitlements"
258
259 codesign --force --deep --entitlements "${app_path}/Contents/Resources/zed.entitlements" --sign ${MACOS_SIGNING_KEY:- -} "${app_path}" -v
260 fi
261
262 if [[ "$target_dir" = "debug" && "$local_only" = false ]]; then
263 if [ "$open_result" = true ]; then
264 open "$app_path"
265 else
266 echo "Created application bundle:"
267 echo "$app_path"
268 fi
269 exit 0
270 fi
271
272 # If bundle_name is not set or empty, use the basename of $app_path
273 if [ -z "$bundle_name" ]; then
274 bundle_name=$(basename "$app_path")
275 else
276 # If bundle_name doesn't end in .app, append it
277 if [[ "$bundle_name" != *.app ]]; then
278 bundle_name="$bundle_name.app"
279 fi
280 fi
281
282 if [ "$local_only" = true ]; then
283 if [ "$local_install" = true ]; then
284 rm -rf "/Applications/$bundle_name"
285 mv "$app_path" "/Applications/$bundle_name"
286 echo "Installed application bundle: /Applications/$bundle_name"
287 if [ "$open_result" = true ]; then
288 echo "Opening /Applications/$bundle_name"
289 open "/Applications/$bundle_name"
290 fi
291 else
292 if [ "$open_result" = true ]; then
293 echo "Opening $app_path"
294 open "$app_path"
295 fi
296 fi
297 else
298 dmg_target_directory="target/${architecture_dir}/${target_dir}"
299 dmg_source_directory="${dmg_target_directory}/dmg"
300 dmg_file_path="${dmg_target_directory}/Zed.dmg"
301 xcode_bin_dir_path="$(xcode-select -p)/usr/bin"
302
303 rm -rf ${dmg_source_directory}
304 mkdir -p ${dmg_source_directory}
305 mv "${app_path}" "${dmg_source_directory}"
306
307 if [[ $can_code_sign = true ]]; then
308 echo "Creating temporary DMG at ${dmg_file_path} using ${dmg_source_directory} to notarize app bundle"
309 hdiutil create -volname Zed -srcfolder "${dmg_source_directory}" -ov -format UDZO "${dmg_file_path}"
310
311 echo "Code-signing DMG"
312 /usr/bin/codesign --deep --force --timestamp --options runtime --sign "$IDENTITY" "$(pwd)/${dmg_file_path}" -v
313
314 echo "Notarizing DMG with Apple"
315 "${xcode_bin_dir_path}/notarytool" submit --wait --apple-id "$APPLE_NOTARIZATION_USERNAME" --password "$APPLE_NOTARIZATION_PASSWORD" --team-id "$APPLE_NOTORIZATION_TEAM" "${dmg_file_path}"
316
317 echo "Removing temporary DMG (used only for notarization)"
318 rm "${dmg_file_path}"
319
320 echo "Stapling notarization ticket to ${dmg_source_directory}/${bundle_name}"
321 "${xcode_bin_dir_path}/stapler" staple "${dmg_source_directory}/${bundle_name}"
322 fi
323
324 echo "Adding symlink to /Applications to ${dmg_source_directory}"
325 ln -s /Applications ${dmg_source_directory}
326
327 echo "Creating final DMG at ${dmg_file_path} using ${dmg_source_directory}"
328 hdiutil create -volname Zed -srcfolder "${dmg_source_directory}" -ov -format UDZO "${dmg_file_path}"
329
330 # If someone runs this bundle script locally, a symlink will be placed in `dmg_source_directory`.
331 # This symlink causes CPU issues with Zed if the Zed codebase is the project being worked on, so we simply remove it for now.
332 echo "Removing symlink to /Applications from ${dmg_source_directory}"
333 rm ${dmg_source_directory}/Applications
334
335 echo "Adding license agreement to DMG"
336 npm install --global dmg-license minimist
337 dmg-license script/eula/eula.json "${dmg_file_path}"
338
339 if [[ $can_code_sign = true ]]; then
340 echo "Notarizing DMG with Apple"
341 /usr/bin/codesign --deep --force --timestamp --options runtime --sign "$IDENTITY" "$(pwd)/${dmg_file_path}" -v
342 "${xcode_bin_dir_path}/notarytool" submit --wait --apple-id "$APPLE_NOTARIZATION_USERNAME" --password "$APPLE_NOTARIZATION_PASSWORD" --team-id "$APPLE_NOTORIZATION_TEAM" "${dmg_file_path}"
343 "${xcode_bin_dir_path}/stapler" staple "${dmg_file_path}"
344 fi
345
346 if [ "$open_result" = true ]; then
347 open $dmg_target_directory
348 fi
349 fi
350}
351
352function sign_binary() {
353 local binary_path=$1
354
355 if [[ $can_code_sign = true ]]; then
356 echo "Code signing executable $binary_path"
357 /usr/bin/codesign --deep --force --timestamp --options runtime --sign "$IDENTITY" "${app_path}" -v
358 fi
359}
360
361if [ "$local_arch" = true ]; then
362 sign_app_binaries "$app_path" "$local_target_triple" "$local_target_triple"
363
364 sign_binary "target/release/remote_server"
365else
366 # Create universal binary
367 prepare_binaries "aarch64-apple-darwin" "$app_path_aarch64"
368 prepare_binaries "x86_64-apple-darwin" "$app_path_x64"
369
370 cp -R "$app_path_x64" target/release/
371 app_path=target/release/$(basename "$app_path_x64")
372 lipo \
373 -create \
374 target/{x86_64-apple-darwin,aarch64-apple-darwin}/${target_dir}/zed \
375 -output \
376 "${app_path}/Contents/MacOS/zed"
377 lipo \
378 -create \
379 target/{x86_64-apple-darwin,aarch64-apple-darwin}/${target_dir}/cli \
380 -output \
381 "${app_path}/Contents/MacOS/cli"
382
383 sign_app_binaries "$app_path" "universal" "."
384 sign_app_binaries "$app_path_x64" "x86_64-apple-darwin" "x86_64-apple-darwin"
385 sign_app_binaries "$app_path_aarch64" "aarch64-apple-darwin" "aarch64-apple-darwin"
386
387 sign_binary "target/x86_64-apple-darwin/release/remote_server"
388 sign_binary "target/aarch64-apple-darwin/release/remote_server"
389 gzip --stdout --best target/x86_64-apple-darwin/release/remote_server > target/zed-remote-server-mac-x86_64.gz
390 gzip --stdout --best target/aarch64-apple-darwin/release/remote_server > target/zed-remote-server-mac-aarch64.gz
391fi