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