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_NOTARIZATION_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
66# Get release channel
67pushd crates/zed
68channel=$(<RELEASE_CHANNEL)
69export ZED_RELEASE_CHANNEL="${channel}"
70popd
71
72export ZED_BUNDLE=true
73
74cargo_bundle_version=$(cargo -q bundle --help 2>&1 | head -n 1 || echo "")
75if [ "$cargo_bundle_version" != "cargo-bundle v0.6.1-zed" ]; then
76 cargo install cargo-bundle --git https://github.com/zed-industries/cargo-bundle.git --branch zed-deploy
77fi
78
79# Deal with versions of macOS that don't include libstdc++ headers
80export CXXFLAGS="-stdlib=libc++"
81
82version_info=$(rustc --version --verbose)
83host_line=$(echo "$version_info" | grep host)
84local_target_triple=${host_line#*: }
85
86# Generate the licenses first, so they can be baked into the binaries
87script/generate-licenses
88
89if [ "$local_arch" = true ]; then
90 echo "Building for local target only."
91 cargo build ${build_flag} --package zed --package cli --package remote_server
92else
93 rustup target add aarch64-apple-darwin
94 rustup target add x86_64-apple-darwin
95
96 echo "Compiling zed binaries"
97 cargo build ${build_flag} --package zed --package cli --target aarch64-apple-darwin --target x86_64-apple-darwin
98 # Build remote_server in separate invocation to prevent feature unification from other crates
99 # from influencing dynamic libraries required by it.
100 cargo build ${build_flag} --package remote_server --target aarch64-apple-darwin --target x86_64-apple-darwin
101fi
102
103echo "Creating application bundle"
104pushd crates/zed
105cp Cargo.toml Cargo.toml.backup
106sed \
107 -i.backup \
108 "s/package.metadata.bundle-${channel}/package.metadata.bundle/" \
109 Cargo.toml
110
111if [ "$local_arch" = true ]; then
112 app_path=$(cargo bundle ${build_flag} --select-workspace-root | xargs)
113else
114 app_path_x64=$(cargo bundle ${build_flag} --target x86_64-apple-darwin --select-workspace-root | xargs)
115 app_path_aarch64=$(cargo bundle ${build_flag} --target aarch64-apple-darwin --select-workspace-root | xargs)
116 app_path=$app_path_x64
117fi
118
119mv Cargo.toml.backup Cargo.toml
120popd
121echo "Bundled ${app_path}"
122
123if [[ -n "${MACOS_CERTIFICATE:-}" && -n "${MACOS_CERTIFICATE_PASSWORD:-}" && -n "${APPLE_NOTARIZATION_KEY:-}" && -n "${APPLE_NOTARIZATION_KEY_ID:-}" && -n "${APPLE_NOTARIZATION_ISSUER_ID:-}" ]]; then
124 can_code_sign=true
125
126 echo "Setting up keychain for code signing..."
127 security create-keychain -p "$MACOS_CERTIFICATE_PASSWORD" zed.keychain || echo ""
128 security default-keychain -s zed.keychain
129 security unlock-keychain -p "$MACOS_CERTIFICATE_PASSWORD" zed.keychain
130 echo "$MACOS_CERTIFICATE" | base64 --decode > /tmp/zed-certificate.p12
131 security import /tmp/zed-certificate.p12 -k zed.keychain -P "$MACOS_CERTIFICATE_PASSWORD" -T /usr/bin/codesign
132 rm /tmp/zed-certificate.p12
133 security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k "$MACOS_CERTIFICATE_PASSWORD" zed.keychain
134
135 function cleanup() {
136 echo "Cleaning up keychain"
137 security default-keychain -s login.keychain
138 security delete-keychain zed.keychain
139 }
140
141 trap cleanup EXIT
142fi
143
144GIT_VERSION="v2.43.3"
145GIT_VERSION_SHA="fa29823"
146
147function download_and_unpack() {
148 local url=$1
149 local path_to_unpack=$2
150 local target_path=$3
151
152 temp_dir=$(mktemp -d)
153
154 if ! command -v curl &> /dev/null; then
155 echo "curl is not installed. Please install curl to continue."
156 exit 1
157 fi
158
159 curl --silent --fail --location "$url" | tar -xvz -C "$temp_dir" -f - $path_to_unpack
160
161 mv "$temp_dir/$path_to_unpack" "$target_path"
162
163 rm -rf "$temp_dir"
164}
165
166function download_git() {
167 local architecture=$1
168 local target_binary=$2
169
170 tmp_dir=$(mktemp -d)
171 pushd "$tmp_dir"
172
173 case "$architecture" in
174 aarch64-apple-darwin)
175 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
176 ;;
177 x86_64-apple-darwin)
178 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
179 ;;
180 *)
181 echo "Unsupported architecture: $architecture"
182 exit 1
183 ;;
184 esac
185
186 popd
187
188 mv "${tmp_dir}/git" "${target_binary}"
189 rm -rf "$tmp_dir"
190}
191
192function prepare_binaries() {
193 local architecture=$1
194 local app_path=$2
195
196 echo "Unpacking dSYMs for $architecture"
197 exe_path="target/${architecture}/${target_dir}/Zed"
198 if ! dsymutil --flat "${exe_path}" 2> target/dsymutil.log; then
199 echo "dsymutil failed"
200 cat target/dsymutil.log
201 exit 1
202 fi
203 uuid=$(dwarfdump --uuid "${exe_path}" | cut -d ' ' -f 2 | tr 'A-F' 'a-f')
204 version="$(cargo metadata --no-deps --manifest-path crates/zed/Cargo.toml --offline --format-version=1 | jq -r '.packages | map(select(.name == "zed"))[0].version')"
205 if [ "$channel" == "nightly" ]; then
206 version="$version-$(git rev-parse --short HEAD)"
207 fi
208
209 echo "Removing existing gzipped dSYMs for $architecture"
210 rm -f target/${architecture}/${target_dir}/Zed.dwarf.gz
211
212 echo "Gzipping dSYMs for $architecture"
213 gzip -kf target/${architecture}/${target_dir}/Zed.dwarf
214
215 echo "Uploading dSYMs${architecture} for $architecture to by-uuid/${uuid}.dwarf.gz"
216 upload_to_blob_store_public \
217 "zed-debug-symbols" \
218 target/${architecture}/${target_dir}/Zed.dwarf.gz \
219 "by-uuid/${uuid}.dwarf.gz"
220
221 cp target/${architecture}/${target_dir}/zed "${app_path}/Contents/MacOS/zed"
222 cp target/${architecture}/${target_dir}/cli "${app_path}/Contents/MacOS/cli"
223}
224
225function sign_app_binaries() {
226 local app_path=$1
227 local architecture=$2
228 local architecture_dir=$3
229 rm -rf "${app_path}/Contents/Frameworks"
230 mkdir -p "${app_path}/Contents/Frameworks"
231 if [ "$local_arch" = true ]; then
232 cp -R target/${target_dir}/cli "${app_path}/Contents/MacOS/"
233 fi
234
235 echo "Downloading git binary"
236 download_git "${architecture}" "${app_path}/Contents/MacOS/git"
237
238 # Note: The app identifier for our development builds is the same as the app identifier for nightly.
239 cp crates/zed/contents/$channel/embedded.provisionprofile "${app_path}/Contents/"
240
241 if [[ $can_code_sign = true ]]; then
242 echo "Code signing binaries"
243 # sequence of codesign commands modeled after this example: https://developer.apple.com/forums/thread/701514
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_KEY, APPLE_NOTARIZATION_KEY_ID, APPLE_NOTARIZATION_ISSUER_ID"
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 notarization_key_file=$(mktemp)
314
315 echo "Adding symlink to /Applications to ${dmg_source_directory}"
316 ln -s /Applications ${dmg_source_directory}
317
318 echo "Creating final DMG at ${dmg_file_path} using ${dmg_source_directory}"
319 hdiutil create -volname Zed -srcfolder "${dmg_source_directory}" -ov -format UDZO "${dmg_file_path}"
320
321 # If someone runs this bundle script locally, a symlink will be placed in `dmg_source_directory`.
322 # This symlink causes CPU issues with Zed if the Zed codebase is the project being worked on, so we simply remove it for now.
323 echo "Removing symlink to /Applications from ${dmg_source_directory}"
324 rm ${dmg_source_directory}/Applications
325
326 echo "Adding license agreement to DMG"
327 npm install --global dmg-license minimist
328 dmg-license script/terms/terms.json "${dmg_file_path}"
329
330 if [[ $can_code_sign = true ]]; then
331 echo "Notarizing DMG with Apple"
332 /usr/bin/codesign --deep --force --timestamp --options runtime --sign "$IDENTITY" "$(pwd)/${dmg_file_path}" -v
333 echo "$APPLE_NOTARIZATION_KEY" > "$notarization_key_file"
334 "${xcode_bin_dir_path}/notarytool" submit --wait --key "$notarization_key_file" --key-id "$APPLE_NOTARIZATION_KEY_ID" --issuer "$APPLE_NOTARIZATION_ISSUER_ID" "${dmg_file_path}"
335 rm "$notarization_key_file"
336 "${xcode_bin_dir_path}/stapler" staple "${dmg_file_path}"
337 fi
338
339 if [ "$open_result" = true ]; then
340 open $dmg_target_directory
341 fi
342 fi
343}
344
345function sign_binary() {
346 local binary_path=$1
347
348 if [[ $can_code_sign = true ]]; then
349 echo "Code signing executable $binary_path"
350 /usr/bin/codesign --deep --force --timestamp --options runtime --entitlements crates/zed/resources/zed.entitlements --sign "$IDENTITY" "${binary_path}" -v
351 fi
352}
353
354if [ "$local_arch" = true ]; then
355 sign_app_binaries "$app_path" "$local_target_triple" "$local_target_triple"
356
357 sign_binary "target/release/remote_server"
358else
359 # Create universal binary
360 prepare_binaries "aarch64-apple-darwin" "$app_path_aarch64"
361 prepare_binaries "x86_64-apple-darwin" "$app_path_x64"
362
363
364 sign_app_binaries "$app_path_x64" "x86_64-apple-darwin" "x86_64-apple-darwin"
365 sign_app_binaries "$app_path_aarch64" "aarch64-apple-darwin" "aarch64-apple-darwin"
366
367 sign_binary "target/x86_64-apple-darwin/release/remote_server"
368 sign_binary "target/aarch64-apple-darwin/release/remote_server"
369 gzip -f --stdout --best target/x86_64-apple-darwin/release/remote_server > target/zed-remote-server-macos-x86_64.gz
370 gzip -f --stdout --best target/aarch64-apple-darwin/release/remote_server > target/zed-remote-server-macos-aarch64.gz
371fi
372
373function upload_debug_info() {
374 architecture=$1
375 if [[ -n "${SENTRY_AUTH_TOKEN:-}" ]]; then
376 echo "Uploading zed debug symbols to sentry..."
377 # note: this uploads the unstripped binary which is needed because it contains
378 # .eh_frame data for stack unwinding. see https://github.com/getsentry/symbolic/issues/783
379 sentry-cli debug-files upload --include-sources --wait -p zed -o zed-dev \
380 "target/${architecture}/${target_dir}/zed" \
381 "target/${architecture}/${target_dir}/remote_server" \
382 "target/${architecture}/${target_dir}/zed.dwarf"
383 else
384 echo "missing SENTRY_AUTH_TOKEN. skipping sentry upload."
385 fi
386}
387
388if command -v sentry-cli >/dev/null 2>&1; then
389 upload_debug_info "aarch64-apple-darwin"
390 upload_debug_info "x86_64-apple-darwin"
391else
392 echo "sentry-cli not found. skipping sentry upload."
393 echo "install with: 'curl -sL https://sentry.io/get-cli | bash'"
394fi