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