1name: CI
2
3on:
4 push:
5 branches:
6 - main
7 - "v[0-9]+.[0-9]+.x"
8 tags:
9 - "v*"
10
11 pull_request:
12 branches:
13 - "**"
14
15concurrency:
16 # Allow only one workflow per any non-`main` branch.
17 group: ${{ github.workflow }}-${{ github.ref_name }}-${{ github.ref_name == 'main' && github.sha || 'anysha' }}
18 cancel-in-progress: true
19
20env:
21 CARGO_TERM_COLOR: always
22 CARGO_INCREMENTAL: 0
23 RUST_BACKTRACE: 1
24
25jobs:
26 migration_checks:
27 name: Check Postgres and Protobuf migrations, mergability
28 if: github.repository_owner == 'zed-industries'
29 timeout-minutes: 60
30 runs-on:
31 - self-hosted
32 - test
33 steps:
34 - name: Checkout repo
35 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
36 with:
37 clean: false
38 fetch-depth: 0 # fetch full history
39
40 - name: Remove untracked files
41 run: git clean -df
42
43 - name: Find modified migrations
44 shell: bash -euxo pipefail {0}
45 run: |
46 export SQUAWK_GITHUB_TOKEN=${{ github.token }}
47 . ./script/squawk
48
49 - name: Ensure fresh merge
50 shell: bash -euxo pipefail {0}
51 run: |
52 if [ -z "$GITHUB_BASE_REF" ];
53 then
54 echo "BUF_BASE_BRANCH=$(git merge-base origin/main HEAD)" >> $GITHUB_ENV
55 else
56 git checkout -B temp
57 git merge -q origin/$GITHUB_BASE_REF -m "merge main into temp"
58 echo "BUF_BASE_BRANCH=$GITHUB_BASE_REF" >> $GITHUB_ENV
59 fi
60
61 - uses: bufbuild/buf-setup-action@v1
62 with:
63 version: v1.29.0
64 - uses: bufbuild/buf-breaking-action@v1
65 with:
66 input: "crates/proto/proto/"
67 against: "https://github.com/${GITHUB_REPOSITORY}.git#branch=${BUF_BASE_BRANCH},subdir=crates/proto/proto/"
68
69 style:
70 timeout-minutes: 60
71 name: Check formatting and spelling
72 if: github.repository_owner == 'zed-industries'
73 runs-on:
74 - buildjet-8vcpu-ubuntu-2204
75 steps:
76 - name: Checkout repo
77 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
78
79 # To support writing comments that they will certainly be revisited.
80 - name: Check for todo! and FIXME comments
81 run: script/check-todos
82
83 - name: Run style checks
84 uses: ./.github/actions/check_style
85
86 - name: Check for typos
87 uses: crate-ci/typos@8e6a4285bcbde632c5d79900a7779746e8b7ea3f # v1.24.6
88 with:
89 config: ./typos.toml
90
91 macos_tests:
92 timeout-minutes: 60
93 name: (macOS) Run Clippy and tests
94 if: github.repository_owner == 'zed-industries'
95 runs-on:
96 - self-hosted
97 - test
98 steps:
99 - name: Checkout repo
100 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
101 with:
102 clean: false
103
104 - name: Configure CI
105 run: |
106 mkdir -p ./../.cargo
107 cp ./.cargo/ci-config.toml ./../.cargo/config.toml
108
109 - name: cargo clippy
110 run: ./script/clippy
111
112 - name: Check unused dependencies
113 uses: bnjbvr/cargo-machete@main
114
115 - name: Check licenses
116 run: |
117 script/check-licenses
118 script/generate-licenses /tmp/zed_licenses_output
119
120 - name: Check for new vulnerable dependencies
121 if: github.event_name == 'pull_request'
122 uses: actions/dependency-review-action@3b139cfc5fae8b618d3eae3675e383bb1769c019 # v4
123 with:
124 license-check: false
125
126 - name: Run tests
127 uses: ./.github/actions/run_tests
128
129 - name: Build collab
130 run: cargo build -p collab
131
132 - name: Build other binaries and features
133 run: |
134 cargo build --workspace --bins --all-features
135 cargo check -p gpui --features "macos-blade"
136 cargo check -p workspace
137 cargo build -p remote_server
138 script/check-rust-livekit-macos
139
140 # Since the macOS runners are stateful, so we need to remove the config file to prevent potential bug.
141 - name: Clean CI config file
142 if: always()
143 run: rm -rf ./../.cargo
144
145 linux_tests:
146 timeout-minutes: 60
147 name: (Linux) Run Clippy and tests
148 if: github.repository_owner == 'zed-industries'
149 runs-on:
150 - buildjet-16vcpu-ubuntu-2204
151 steps:
152 - name: Add Rust to the PATH
153 run: echo "$HOME/.cargo/bin" >> $GITHUB_PATH
154
155 - name: Checkout repo
156 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
157 with:
158 clean: false
159
160 - name: Cache dependencies
161 uses: swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2
162 with:
163 save-if: ${{ github.ref == 'refs/heads/main' }}
164 cache-provider: "buildjet"
165
166 - name: Install Linux dependencies
167 run: ./script/linux
168
169 - name: Configure CI
170 run: |
171 mkdir -p ./../.cargo
172 cp ./.cargo/ci-config.toml ./../.cargo/config.toml
173
174 - name: cargo clippy
175 run: ./script/clippy
176
177 - name: Run tests
178 uses: ./.github/actions/run_tests
179
180 - name: Build other binaries and features
181 run: |
182 cargo build -p zed
183 cargo check -p workspace
184
185 # Even the Linux runner is not stateful, in theory there is no need to do this cleanup.
186 # But, to avoid potential issues in the future if we choose to use a stateful Linux runner and forget to add code
187 # to clean up the config file, I’ve included the cleanup code here as a precaution.
188 # While it’s not strictly necessary at this moment, I believe it’s better to err on the side of caution.
189 - name: Clean CI config file
190 if: always()
191 run: rm -rf ./../.cargo
192
193 build_remote_server:
194 timeout-minutes: 60
195 name: (Linux) Build Remote Server
196 if: github.repository_owner == 'zed-industries'
197 runs-on:
198 - buildjet-16vcpu-ubuntu-2204
199 steps:
200 - name: Add Rust to the PATH
201 run: echo "$HOME/.cargo/bin" >> $GITHUB_PATH
202
203 - name: Checkout repo
204 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
205 with:
206 clean: false
207
208 - name: Cache dependencies
209 uses: swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2
210 with:
211 save-if: ${{ github.ref == 'refs/heads/main' }}
212 cache-provider: "buildjet"
213
214 - name: Install Clang & Mold
215 run: ./script/remote-server && ./script/install-mold 2.34.0
216
217 - name: Configure CI
218 run: |
219 mkdir -p ./../.cargo
220 cp ./.cargo/ci-config.toml ./../.cargo/config.toml
221
222 - name: Build Remote Server
223 run: cargo build -p remote_server
224
225 - name: Clean CI config file
226 if: always()
227 run: rm -rf ./../.cargo
228
229 # todo(windows): Actually run the tests
230 windows_tests:
231 timeout-minutes: 60
232 name: (Windows) Run Clippy and tests
233 if: github.repository_owner == 'zed-industries'
234 runs-on: hosted-windows-1
235 steps:
236 # more info here:- https://github.com/rust-lang/cargo/issues/13020
237 - name: Create Dev Drive using ReFS
238 run: |
239 $Volume = New-VHD -Path C:/zed_dev_drive.vhdx -SizeBytes 30GB |
240 Mount-VHD -Passthru |
241 Initialize-Disk -Passthru |
242 New-Partition -AssignDriveLetter -UseMaximumSize |
243 Format-Volume -FileSystem ReFS -Confirm:$false -Force
244 Write-Output $Volume
245 Write-Output "DEV_DRIVE=$($Volume.DriveLetter):" >> $env:GITHUB_ENV
246 - name: Enable longer pathnames for git
247 run: git config --system core.longpaths true
248 - name: Checkout repo
249 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
250 with:
251 clean: false
252 # actions/checkout does not let us clone into anywhere outside ${{ github.workspace }}, so we have to copy the clone...
253 - name: Copy Git Repo to Dev Drive
254 run: |
255 Copy-Item -Path "${{ github.workspace }}" -Destination "${{ env.DEV_DRIVE }}/zed" -Recurse
256
257 - name: Cache dependencies
258 uses: swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2
259 with:
260 save-if: ${{ github.ref == 'refs/heads/main' }}
261 workspaces: ${{ env.DEV_DRIVE }}/zed
262 cache-provider: "github"
263 env:
264 CARGO_HOME: ${{ env.DEV_DRIVE }}/.cargo
265 RUSTUP_HOME: ${{ env.DEV_DRIVE }}/.rustup
266
267 - name: Configure CI
268 run: |
269 mkdir -p ${{ env.DEV_DRIVE }}/.cargo -ErrorAction Ignore
270 cp ./.cargo/ci-config.toml ${{ env.DEV_DRIVE }}/.cargo/config.toml
271
272 - name: cargo clippy
273 # Windows can't run shell scripts, so we need to use `cargo xtask`.
274 run: cargo xtask clippy
275 env:
276 CARGO_HOME: ${{ env.DEV_DRIVE }}/.cargo
277 RUSTUP_HOME: ${{ env.DEV_DRIVE }}/.rustup
278
279 - name: Build Zed
280 run: cargo build
281 env:
282 CARGO_HOME: ${{ env.DEV_DRIVE }}/.cargo
283 RUSTUP_HOME: ${{ env.DEV_DRIVE }}/.rustup
284
285 # Since the Windows runners are stateful, so we need to remove the config file to prevent potential bug.
286 - name: Clean CI config file
287 if: always()
288 run: Remove-Item -Path "${{ env.DEV_DRIVE }}/.cargo/config.toml" -Force
289
290 bundle-mac:
291 timeout-minutes: 120
292 name: Create a macOS bundle
293 runs-on:
294 - self-hosted
295 - bundle
296 if: ${{ startsWith(github.ref, 'refs/tags/v') || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
297 needs: [macos_tests]
298 env:
299 MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }}
300 MACOS_CERTIFICATE_PASSWORD: ${{ secrets.MACOS_CERTIFICATE_PASSWORD }}
301 APPLE_NOTARIZATION_USERNAME: ${{ secrets.APPLE_NOTARIZATION_USERNAME }}
302 APPLE_NOTARIZATION_PASSWORD: ${{ secrets.APPLE_NOTARIZATION_PASSWORD }}
303 ZED_CLIENT_CHECKSUM_SEED: ${{ secrets.ZED_CLIENT_CHECKSUM_SEED }}
304 ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON: ${{ secrets.ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON }}
305 DIGITALOCEAN_SPACES_ACCESS_KEY: ${{ secrets.DIGITALOCEAN_SPACES_ACCESS_KEY }}
306 DIGITALOCEAN_SPACES_SECRET_KEY: ${{ secrets.DIGITALOCEAN_SPACES_SECRET_KEY }}
307 steps:
308 - name: Install Node
309 uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4
310 with:
311 node-version: "18"
312
313 - name: Checkout repo
314 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
315 with:
316 # We need to fetch more than one commit so that `script/draft-release-notes`
317 # is able to diff between the current and previous tag.
318 #
319 # 25 was chosen arbitrarily.
320 fetch-depth: 25
321 clean: false
322 ref: ${{ github.ref }}
323
324 - name: Limit target directory size
325 run: script/clear-target-dir-if-larger-than 100
326
327 - name: Determine version and release channel
328 if: ${{ startsWith(github.ref, 'refs/tags/v') }}
329 run: |
330 # This exports RELEASE_CHANNEL into env (GITHUB_ENV)
331 script/determine-release-channel
332
333 - name: Draft release notes
334 if: ${{ startsWith(github.ref, 'refs/tags/v') }}
335 run: |
336 mkdir -p target/
337 # Ignore any errors that occur while drafting release notes to not fail the build.
338 script/draft-release-notes "$RELEASE_VERSION" "$RELEASE_CHANNEL" > target/release-notes.md || true
339 script/create-draft-release target/release-notes.md
340 env:
341 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
342
343 - name: Create macOS app bundle
344 run: script/bundle-mac
345
346 - name: Rename binaries
347 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
348 run: |
349 mv target/aarch64-apple-darwin/release/Zed.dmg target/aarch64-apple-darwin/release/Zed-aarch64.dmg
350 mv target/x86_64-apple-darwin/release/Zed.dmg target/x86_64-apple-darwin/release/Zed-x86_64.dmg
351
352 - name: Upload app bundle (aarch64) to workflow run if main branch or specific label
353 uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4
354 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
355 with:
356 name: Zed_${{ github.event.pull_request.head.sha || github.sha }}-aarch64.dmg
357 path: target/aarch64-apple-darwin/release/Zed-aarch64.dmg
358
359 - name: Upload app bundle (x86_64) to workflow run if main branch or specific label
360 uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4
361 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
362 with:
363 name: Zed_${{ github.event.pull_request.head.sha || github.sha }}-x86_64.dmg
364 path: target/x86_64-apple-darwin/release/Zed-x86_64.dmg
365
366 - uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # v1
367 name: Upload app bundle to release
368 if: ${{ env.RELEASE_CHANNEL == 'preview' || env.RELEASE_CHANNEL == 'stable' }}
369 with:
370 draft: true
371 prerelease: ${{ env.RELEASE_CHANNEL == 'preview' }}
372 files: |
373 target/zed-remote-server-macos-x86_64.gz
374 target/zed-remote-server-macos-aarch64.gz
375 target/aarch64-apple-darwin/release/Zed-aarch64.dmg
376 target/x86_64-apple-darwin/release/Zed-x86_64.dmg
377 env:
378 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
379
380 bundle-linux-x86_x64:
381 timeout-minutes: 60
382 name: Linux x86_x64 release bundle
383 runs-on:
384 - buildjet-16vcpu-ubuntu-2004
385 if: ${{ startsWith(github.ref, 'refs/tags/v') || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
386 needs: [linux_tests]
387 env:
388 ZED_CLIENT_CHECKSUM_SEED: ${{ secrets.ZED_CLIENT_CHECKSUM_SEED }}
389 ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON: ${{ secrets.ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON }}
390 DIGITALOCEAN_SPACES_ACCESS_KEY: ${{ secrets.DIGITALOCEAN_SPACES_ACCESS_KEY }}
391 DIGITALOCEAN_SPACES_SECRET_KEY: ${{ secrets.DIGITALOCEAN_SPACES_SECRET_KEY }}
392 steps:
393 - name: Checkout repo
394 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
395 with:
396 clean: false
397
398 - name: Install Linux dependencies
399 run: ./script/linux && ./script/install-mold 2.34.0
400
401 - name: Determine version and release channel
402 if: ${{ startsWith(github.ref, 'refs/tags/v') }}
403 run: |
404 # This exports RELEASE_CHANNEL into env (GITHUB_ENV)
405 script/determine-release-channel
406
407 - name: Create Linux .tar.gz bundle
408 run: script/bundle-linux
409
410 - name: Upload Linux bundle to workflow run if main branch or specific label
411 uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4
412 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
413 with:
414 name: zed-${{ github.event.pull_request.head.sha || github.sha }}-x86_64-unknown-linux-gnu.tar.gz
415 path: target/release/zed-*.tar.gz
416
417 - name: Upload app bundle to release
418 uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # v1
419 with:
420 draft: true
421 prerelease: ${{ env.RELEASE_CHANNEL == 'preview' }}
422 files: |
423 target/zed-remote-server-linux-x86_64.gz
424 target/release/zed-linux-x86_64.tar.gz
425 env:
426 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
427
428 bundle-linux-aarch64: # this runs on ubuntu22.04
429 timeout-minutes: 60
430 name: Linux arm64 release bundle
431 runs-on:
432 - buildjet-16vcpu-ubuntu-2204-arm
433 if: ${{ startsWith(github.ref, 'refs/tags/v') || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
434 needs: [linux_tests]
435 env:
436 ZED_CLIENT_CHECKSUM_SEED: ${{ secrets.ZED_CLIENT_CHECKSUM_SEED }}
437 ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON: ${{ secrets.ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON }}
438 DIGITALOCEAN_SPACES_ACCESS_KEY: ${{ secrets.DIGITALOCEAN_SPACES_ACCESS_KEY }}
439 DIGITALOCEAN_SPACES_SECRET_KEY: ${{ secrets.DIGITALOCEAN_SPACES_SECRET_KEY }}
440 steps:
441 - name: Checkout repo
442 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
443 with:
444 clean: false
445
446 - name: Install Linux dependencies
447 run: ./script/linux
448
449 - name: Determine version and release channel
450 if: ${{ startsWith(github.ref, 'refs/tags/v') }}
451 run: |
452 # This exports RELEASE_CHANNEL into env (GITHUB_ENV)
453 script/determine-release-channel
454
455 - name: Create and upload Linux .tar.gz bundle
456 run: script/bundle-linux
457
458 - name: Upload Linux bundle to workflow run if main branch or specific label
459 uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4
460 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
461 with:
462 name: zed-${{ github.event.pull_request.head.sha || github.sha }}-aarch64-unknown-linux-gnu.tar.gz
463 path: target/release/zed-*.tar.gz
464
465 - name: Upload app bundle to release
466 uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # v1
467 with:
468 draft: true
469 prerelease: ${{ env.RELEASE_CHANNEL == 'preview' }}
470 files: |
471 target/zed-remote-server-linux-aarch64.gz
472 target/release/zed-linux-aarch64.tar.gz
473 env:
474 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
475
476 auto-release-preview:
477 name: Auto release preview
478 if: ${{ startsWith(github.ref, 'refs/tags/v') && endsWith(github.ref, '-pre') && !endsWith(github.ref, '.0-pre') }}
479 needs: [bundle-mac, bundle-linux-x86_x64, bundle-linux-aarch64]
480 runs-on:
481 - self-hosted
482 - bundle
483 steps:
484 - name: gh release
485 run: gh release edit $GITHUB_REF_NAME --draft=false
486 env:
487 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}