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 cargo check -p gpui --examples
139 script/check-rust-livekit-macos
140
141 # Since the macOS runners are stateful, so we need to remove the config file to prevent potential bug.
142 - name: Clean CI config file
143 if: always()
144 run: rm -rf ./../.cargo
145
146 linux_tests:
147 timeout-minutes: 60
148 name: (Linux) Run Clippy and tests
149 if: github.repository_owner == 'zed-industries'
150 runs-on:
151 - buildjet-16vcpu-ubuntu-2204
152 steps:
153 - name: Add Rust to the PATH
154 run: echo "$HOME/.cargo/bin" >> $GITHUB_PATH
155
156 - name: Checkout repo
157 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
158 with:
159 clean: false
160
161 - name: Cache dependencies
162 uses: swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2
163 with:
164 save-if: ${{ github.ref == 'refs/heads/main' }}
165 cache-provider: "buildjet"
166
167 - name: Install Linux dependencies
168 run: ./script/linux
169
170 - name: Configure CI
171 run: |
172 mkdir -p ./../.cargo
173 cp ./.cargo/ci-config.toml ./../.cargo/config.toml
174
175 - name: cargo clippy
176 run: ./script/clippy
177
178 - name: Run tests
179 uses: ./.github/actions/run_tests
180
181 - name: Build other binaries and features
182 run: |
183 cargo build -p zed
184 cargo check -p workspace
185 cargo check -p gpui --examples
186
187 # Even the Linux runner is not stateful, in theory there is no need to do this cleanup.
188 # But, to avoid potential issues in the future if we choose to use a stateful Linux runner and forget to add code
189 # to clean up the config file, I’ve included the cleanup code here as a precaution.
190 # While it’s not strictly necessary at this moment, I believe it’s better to err on the side of caution.
191 - name: Clean CI config file
192 if: always()
193 run: rm -rf ./../.cargo
194
195 build_remote_server:
196 timeout-minutes: 60
197 name: (Linux) Build Remote Server
198 if: github.repository_owner == 'zed-industries'
199 runs-on:
200 - buildjet-16vcpu-ubuntu-2204
201 steps:
202 - name: Add Rust to the PATH
203 run: echo "$HOME/.cargo/bin" >> $GITHUB_PATH
204
205 - name: Checkout repo
206 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
207 with:
208 clean: false
209
210 - name: Cache dependencies
211 uses: swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2
212 with:
213 save-if: ${{ github.ref == 'refs/heads/main' }}
214 cache-provider: "buildjet"
215
216 - name: Install Clang & Mold
217 run: ./script/remote-server && ./script/install-mold 2.34.0
218
219 - name: Configure CI
220 run: |
221 mkdir -p ./../.cargo
222 cp ./.cargo/ci-config.toml ./../.cargo/config.toml
223
224 - name: Build Remote Server
225 run: cargo build -p remote_server
226
227 - name: Clean CI config file
228 if: always()
229 run: rm -rf ./../.cargo
230
231 windows_tests:
232 timeout-minutes: 60
233 name: (Windows) Run Clippy and tests
234 if: github.repository_owner == 'zed-industries'
235 runs-on: hosted-windows-1
236 steps:
237 # more info here:- https://github.com/rust-lang/cargo/issues/13020
238 - name: Enable longer pathnames for git
239 run: git config --system core.longpaths true
240
241 - name: Checkout repo
242 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
243 with:
244 clean: false
245
246 - name: Create Dev Drive using ReFS
247 run: ./script/setup-dev-driver.ps1
248
249 # actions/checkout does not let us clone into anywhere outside ${{ github.workspace }}, so we have to copy the clone...
250 - name: Copy Git Repo to Dev Drive
251 run: |
252 Copy-Item -Path "${{ github.workspace }}" -Destination "${{ env.ZED_WORKSPACE }}" -Recurse
253
254 - name: Cache dependencies
255 uses: swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2
256 with:
257 save-if: ${{ github.ref == 'refs/heads/main' }}
258 workspaces: ${{ env.ZED_WORKSPACE }}
259 cache-provider: "github"
260
261 - name: Configure CI
262 run: |
263 mkdir -p ${{ env.CARGO_HOME }} -ErrorAction Ignore
264 cp ./.cargo/ci-config.toml ${{ env.CARGO_HOME }}/config.toml
265
266 - name: cargo clippy
267 working-directory: ${{ env.ZED_WORKSPACE }}
268 # Windows can't run shell scripts, so we need to use `cargo xtask`.
269 run: cargo xtask clippy
270
271 - name: Run tests
272 uses: ./.github/actions/run_tests_windows
273 with:
274 working-directory: ${{ env.ZED_WORKSPACE }}
275
276 - name: Build Zed
277 working-directory: ${{ env.ZED_WORKSPACE }}
278 run: cargo build
279
280 - name: Check dev drive space
281 working-directory: ${{ env.ZED_WORKSPACE }}
282 run: ./script/exit-ci-if-dev-drive-is-full.ps1 55
283
284 # Since the Windows runners are stateful, so we need to remove the config file to prevent potential bug.
285 - name: Clean CI config file
286 if: always()
287 run: Remove-Item -Path "${{ env.CARGO_HOME }}/config.toml" -Force
288
289 bundle-mac:
290 timeout-minutes: 120
291 name: Create a macOS bundle
292 runs-on:
293 - self-hosted
294 - bundle
295 if: ${{ startsWith(github.ref, 'refs/tags/v') || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
296 needs: [macos_tests]
297 env:
298 MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }}
299 MACOS_CERTIFICATE_PASSWORD: ${{ secrets.MACOS_CERTIFICATE_PASSWORD }}
300 APPLE_NOTARIZATION_USERNAME: ${{ secrets.APPLE_NOTARIZATION_USERNAME }}
301 APPLE_NOTARIZATION_PASSWORD: ${{ secrets.APPLE_NOTARIZATION_PASSWORD }}
302 ZED_CLIENT_CHECKSUM_SEED: ${{ secrets.ZED_CLIENT_CHECKSUM_SEED }}
303 ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON: ${{ secrets.ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON }}
304 DIGITALOCEAN_SPACES_ACCESS_KEY: ${{ secrets.DIGITALOCEAN_SPACES_ACCESS_KEY }}
305 DIGITALOCEAN_SPACES_SECRET_KEY: ${{ secrets.DIGITALOCEAN_SPACES_SECRET_KEY }}
306 steps:
307 - name: Install Node
308 uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4
309 with:
310 node-version: "18"
311
312 - name: Checkout repo
313 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
314 with:
315 # We need to fetch more than one commit so that `script/draft-release-notes`
316 # is able to diff between the current and previous tag.
317 #
318 # 25 was chosen arbitrarily.
319 fetch-depth: 25
320 clean: false
321 ref: ${{ github.ref }}
322
323 - name: Limit target directory size
324 run: script/clear-target-dir-if-larger-than 100
325
326 - name: Determine version and release channel
327 if: ${{ startsWith(github.ref, 'refs/tags/v') }}
328 run: |
329 # This exports RELEASE_CHANNEL into env (GITHUB_ENV)
330 script/determine-release-channel
331
332 - name: Draft release notes
333 if: ${{ startsWith(github.ref, 'refs/tags/v') }}
334 run: |
335 mkdir -p target/
336 # Ignore any errors that occur while drafting release notes to not fail the build.
337 script/draft-release-notes "$RELEASE_VERSION" "$RELEASE_CHANNEL" > target/release-notes.md || true
338 script/create-draft-release target/release-notes.md
339 env:
340 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
341
342 - name: Create macOS app bundle
343 run: script/bundle-mac
344
345 - name: Rename binaries
346 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
347 run: |
348 mv target/aarch64-apple-darwin/release/Zed.dmg target/aarch64-apple-darwin/release/Zed-aarch64.dmg
349 mv target/x86_64-apple-darwin/release/Zed.dmg target/x86_64-apple-darwin/release/Zed-x86_64.dmg
350
351 - name: Upload app bundle (aarch64) to workflow run if main branch or specific label
352 uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4
353 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
354 with:
355 name: Zed_${{ github.event.pull_request.head.sha || github.sha }}-aarch64.dmg
356 path: target/aarch64-apple-darwin/release/Zed-aarch64.dmg
357
358 - name: Upload app bundle (x86_64) to workflow run if main branch or specific label
359 uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4
360 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
361 with:
362 name: Zed_${{ github.event.pull_request.head.sha || github.sha }}-x86_64.dmg
363 path: target/x86_64-apple-darwin/release/Zed-x86_64.dmg
364
365 - uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # v1
366 name: Upload app bundle to release
367 if: ${{ env.RELEASE_CHANNEL == 'preview' || env.RELEASE_CHANNEL == 'stable' }}
368 with:
369 draft: true
370 prerelease: ${{ env.RELEASE_CHANNEL == 'preview' }}
371 files: |
372 target/zed-remote-server-macos-x86_64.gz
373 target/zed-remote-server-macos-aarch64.gz
374 target/aarch64-apple-darwin/release/Zed-aarch64.dmg
375 target/x86_64-apple-darwin/release/Zed-x86_64.dmg
376 env:
377 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
378
379 bundle-linux-x86_x64:
380 timeout-minutes: 60
381 name: Linux x86_x64 release bundle
382 runs-on:
383 - buildjet-16vcpu-ubuntu-2004
384 if: ${{ startsWith(github.ref, 'refs/tags/v') || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
385 needs: [linux_tests]
386 env:
387 ZED_CLIENT_CHECKSUM_SEED: ${{ secrets.ZED_CLIENT_CHECKSUM_SEED }}
388 ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON: ${{ secrets.ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON }}
389 DIGITALOCEAN_SPACES_ACCESS_KEY: ${{ secrets.DIGITALOCEAN_SPACES_ACCESS_KEY }}
390 DIGITALOCEAN_SPACES_SECRET_KEY: ${{ secrets.DIGITALOCEAN_SPACES_SECRET_KEY }}
391 steps:
392 - name: Checkout repo
393 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
394 with:
395 clean: false
396
397 - name: Install Linux dependencies
398 run: ./script/linux && ./script/install-mold 2.34.0
399
400 - name: Determine version and release channel
401 if: ${{ startsWith(github.ref, 'refs/tags/v') }}
402 run: |
403 # This exports RELEASE_CHANNEL into env (GITHUB_ENV)
404 script/determine-release-channel
405
406 - name: Create Linux .tar.gz bundle
407 run: script/bundle-linux
408
409 - name: Upload Linux bundle to workflow run if main branch or specific label
410 uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4
411 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
412 with:
413 name: zed-${{ github.event.pull_request.head.sha || github.sha }}-x86_64-unknown-linux-gnu.tar.gz
414 path: target/release/zed-*.tar.gz
415
416 - name: Upload app bundle to release
417 uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # v1
418 with:
419 draft: true
420 prerelease: ${{ env.RELEASE_CHANNEL == 'preview' }}
421 files: |
422 target/zed-remote-server-linux-x86_64.gz
423 target/release/zed-linux-x86_64.tar.gz
424 env:
425 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
426
427 bundle-linux-aarch64: # this runs on ubuntu22.04
428 timeout-minutes: 60
429 name: Linux arm64 release bundle
430 runs-on:
431 - buildjet-16vcpu-ubuntu-2204-arm
432 if: ${{ startsWith(github.ref, 'refs/tags/v') || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
433 needs: [linux_tests]
434 env:
435 ZED_CLIENT_CHECKSUM_SEED: ${{ secrets.ZED_CLIENT_CHECKSUM_SEED }}
436 ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON: ${{ secrets.ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON }}
437 DIGITALOCEAN_SPACES_ACCESS_KEY: ${{ secrets.DIGITALOCEAN_SPACES_ACCESS_KEY }}
438 DIGITALOCEAN_SPACES_SECRET_KEY: ${{ secrets.DIGITALOCEAN_SPACES_SECRET_KEY }}
439 steps:
440 - name: Checkout repo
441 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
442 with:
443 clean: false
444
445 - name: Install Linux dependencies
446 run: ./script/linux
447
448 - name: Determine version and release channel
449 if: ${{ startsWith(github.ref, 'refs/tags/v') }}
450 run: |
451 # This exports RELEASE_CHANNEL into env (GITHUB_ENV)
452 script/determine-release-channel
453
454 - name: Create and upload Linux .tar.gz bundle
455 run: script/bundle-linux
456
457 - name: Upload Linux bundle to workflow run if main branch or specific label
458 uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4
459 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
460 with:
461 name: zed-${{ github.event.pull_request.head.sha || github.sha }}-aarch64-unknown-linux-gnu.tar.gz
462 path: target/release/zed-*.tar.gz
463
464 - name: Upload app bundle to release
465 uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # v1
466 with:
467 draft: true
468 prerelease: ${{ env.RELEASE_CHANNEL == 'preview' }}
469 files: |
470 target/zed-remote-server-linux-aarch64.gz
471 target/release/zed-linux-aarch64.tar.gz
472 env:
473 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
474
475 auto-release-preview:
476 name: Auto release preview
477 if: ${{ startsWith(github.ref, 'refs/tags/v') && endsWith(github.ref, '-pre') && !endsWith(github.ref, '.0-pre') }}
478 needs: [bundle-mac, bundle-linux-x86_x64, bundle-linux-aarch64]
479 runs-on:
480 - self-hosted
481 - bundle
482 steps:
483 - name: gh release
484 run: gh release edit $GITHUB_REF_NAME --draft=false
485 env:
486 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}