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 # todo(windows): Actually run the tests
232 windows_tests:
233 timeout-minutes: 60
234 name: (Windows) Run Clippy and tests
235 if: github.repository_owner == 'zed-industries'
236 runs-on: hosted-windows-1
237 steps:
238 # more info here:- https://github.com/rust-lang/cargo/issues/13020
239 - name: Enable longer pathnames for git
240 run: git config --system core.longpaths true
241
242 - name: Checkout repo
243 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
244 with:
245 clean: false
246
247 - name: Create Dev Drive using ReFS
248 run: ./script/setup-dev-driver.ps1
249
250 # actions/checkout does not let us clone into anywhere outside ${{ github.workspace }}, so we have to copy the clone...
251 - name: Copy Git Repo to Dev Drive
252 run: |
253 Copy-Item -Path "${{ github.workspace }}" -Destination "${{ env.ZED_WORKSPACE }}" -Recurse
254
255 - name: Cache dependencies
256 uses: swatinem/rust-cache@f0deed1e0edfc6a9be95417288c0e1099b1eeec3 # v2
257 with:
258 save-if: ${{ github.ref == 'refs/heads/main' }}
259 workspaces: ${{ env.ZED_WORKSPACE }}
260 cache-provider: "github"
261
262 - name: Configure CI
263 run: |
264 mkdir -p ${{ env.CARGO_HOME }} -ErrorAction Ignore
265 cp ./.cargo/ci-config.toml ${{ env.CARGO_HOME }}/config.toml
266
267 - name: cargo clippy
268 working-directory: ${{ env.ZED_WORKSPACE }}
269 # Windows can't run shell scripts, so we need to use `cargo xtask`.
270 run: cargo xtask clippy
271
272 - name: Build Zed
273 working-directory: ${{ env.ZED_WORKSPACE }}
274 run: cargo build
275
276 # Since the Windows runners are stateful, so we need to remove the config file to prevent potential bug.
277 - name: Clean CI config file
278 if: always()
279 run: Remove-Item -Path "${{ env.CARGO_HOME }}/config.toml" -Force
280
281 bundle-mac:
282 timeout-minutes: 120
283 name: Create a macOS bundle
284 runs-on:
285 - self-hosted
286 - bundle
287 if: ${{ startsWith(github.ref, 'refs/tags/v') || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
288 needs: [macos_tests]
289 env:
290 MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }}
291 MACOS_CERTIFICATE_PASSWORD: ${{ secrets.MACOS_CERTIFICATE_PASSWORD }}
292 APPLE_NOTARIZATION_USERNAME: ${{ secrets.APPLE_NOTARIZATION_USERNAME }}
293 APPLE_NOTARIZATION_PASSWORD: ${{ secrets.APPLE_NOTARIZATION_PASSWORD }}
294 ZED_CLIENT_CHECKSUM_SEED: ${{ secrets.ZED_CLIENT_CHECKSUM_SEED }}
295 ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON: ${{ secrets.ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON }}
296 DIGITALOCEAN_SPACES_ACCESS_KEY: ${{ secrets.DIGITALOCEAN_SPACES_ACCESS_KEY }}
297 DIGITALOCEAN_SPACES_SECRET_KEY: ${{ secrets.DIGITALOCEAN_SPACES_SECRET_KEY }}
298 steps:
299 - name: Install Node
300 uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4
301 with:
302 node-version: "18"
303
304 - name: Checkout repo
305 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
306 with:
307 # We need to fetch more than one commit so that `script/draft-release-notes`
308 # is able to diff between the current and previous tag.
309 #
310 # 25 was chosen arbitrarily.
311 fetch-depth: 25
312 clean: false
313 ref: ${{ github.ref }}
314
315 - name: Limit target directory size
316 run: script/clear-target-dir-if-larger-than 100
317
318 - name: Determine version and release channel
319 if: ${{ startsWith(github.ref, 'refs/tags/v') }}
320 run: |
321 # This exports RELEASE_CHANNEL into env (GITHUB_ENV)
322 script/determine-release-channel
323
324 - name: Draft release notes
325 if: ${{ startsWith(github.ref, 'refs/tags/v') }}
326 run: |
327 mkdir -p target/
328 # Ignore any errors that occur while drafting release notes to not fail the build.
329 script/draft-release-notes "$RELEASE_VERSION" "$RELEASE_CHANNEL" > target/release-notes.md || true
330 script/create-draft-release target/release-notes.md
331 env:
332 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
333
334 - name: Create macOS app bundle
335 run: script/bundle-mac
336
337 - name: Rename binaries
338 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
339 run: |
340 mv target/aarch64-apple-darwin/release/Zed.dmg target/aarch64-apple-darwin/release/Zed-aarch64.dmg
341 mv target/x86_64-apple-darwin/release/Zed.dmg target/x86_64-apple-darwin/release/Zed-x86_64.dmg
342
343 - name: Upload app bundle (aarch64) to workflow run if main branch or specific label
344 uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4
345 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
346 with:
347 name: Zed_${{ github.event.pull_request.head.sha || github.sha }}-aarch64.dmg
348 path: target/aarch64-apple-darwin/release/Zed-aarch64.dmg
349
350 - name: Upload app bundle (x86_64) to workflow run if main branch or specific label
351 uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4
352 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
353 with:
354 name: Zed_${{ github.event.pull_request.head.sha || github.sha }}-x86_64.dmg
355 path: target/x86_64-apple-darwin/release/Zed-x86_64.dmg
356
357 - uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # v1
358 name: Upload app bundle to release
359 if: ${{ env.RELEASE_CHANNEL == 'preview' || env.RELEASE_CHANNEL == 'stable' }}
360 with:
361 draft: true
362 prerelease: ${{ env.RELEASE_CHANNEL == 'preview' }}
363 files: |
364 target/zed-remote-server-macos-x86_64.gz
365 target/zed-remote-server-macos-aarch64.gz
366 target/aarch64-apple-darwin/release/Zed-aarch64.dmg
367 target/x86_64-apple-darwin/release/Zed-x86_64.dmg
368 env:
369 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
370
371 bundle-linux-x86_x64:
372 timeout-minutes: 60
373 name: Linux x86_x64 release bundle
374 runs-on:
375 - buildjet-16vcpu-ubuntu-2004
376 if: ${{ startsWith(github.ref, 'refs/tags/v') || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
377 needs: [linux_tests]
378 env:
379 ZED_CLIENT_CHECKSUM_SEED: ${{ secrets.ZED_CLIENT_CHECKSUM_SEED }}
380 ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON: ${{ secrets.ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON }}
381 DIGITALOCEAN_SPACES_ACCESS_KEY: ${{ secrets.DIGITALOCEAN_SPACES_ACCESS_KEY }}
382 DIGITALOCEAN_SPACES_SECRET_KEY: ${{ secrets.DIGITALOCEAN_SPACES_SECRET_KEY }}
383 steps:
384 - name: Checkout repo
385 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
386 with:
387 clean: false
388
389 - name: Install Linux dependencies
390 run: ./script/linux && ./script/install-mold 2.34.0
391
392 - name: Determine version and release channel
393 if: ${{ startsWith(github.ref, 'refs/tags/v') }}
394 run: |
395 # This exports RELEASE_CHANNEL into env (GITHUB_ENV)
396 script/determine-release-channel
397
398 - name: Create Linux .tar.gz bundle
399 run: script/bundle-linux
400
401 - name: Upload Linux bundle to workflow run if main branch or specific label
402 uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4
403 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
404 with:
405 name: zed-${{ github.event.pull_request.head.sha || github.sha }}-x86_64-unknown-linux-gnu.tar.gz
406 path: target/release/zed-*.tar.gz
407
408 - name: Upload app bundle to release
409 uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # v1
410 with:
411 draft: true
412 prerelease: ${{ env.RELEASE_CHANNEL == 'preview' }}
413 files: |
414 target/zed-remote-server-linux-x86_64.gz
415 target/release/zed-linux-x86_64.tar.gz
416 env:
417 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
418
419 bundle-linux-aarch64: # this runs on ubuntu22.04
420 timeout-minutes: 60
421 name: Linux arm64 release bundle
422 runs-on:
423 - buildjet-16vcpu-ubuntu-2204-arm
424 if: ${{ startsWith(github.ref, 'refs/tags/v') || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
425 needs: [linux_tests]
426 env:
427 ZED_CLIENT_CHECKSUM_SEED: ${{ secrets.ZED_CLIENT_CHECKSUM_SEED }}
428 ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON: ${{ secrets.ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON }}
429 DIGITALOCEAN_SPACES_ACCESS_KEY: ${{ secrets.DIGITALOCEAN_SPACES_ACCESS_KEY }}
430 DIGITALOCEAN_SPACES_SECRET_KEY: ${{ secrets.DIGITALOCEAN_SPACES_SECRET_KEY }}
431 steps:
432 - name: Checkout repo
433 uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
434 with:
435 clean: false
436
437 - name: Install Linux dependencies
438 run: ./script/linux
439
440 - name: Determine version and release channel
441 if: ${{ startsWith(github.ref, 'refs/tags/v') }}
442 run: |
443 # This exports RELEASE_CHANNEL into env (GITHUB_ENV)
444 script/determine-release-channel
445
446 - name: Create and upload Linux .tar.gz bundle
447 run: script/bundle-linux
448
449 - name: Upload Linux bundle to workflow run if main branch or specific label
450 uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4
451 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
452 with:
453 name: zed-${{ github.event.pull_request.head.sha || github.sha }}-aarch64-unknown-linux-gnu.tar.gz
454 path: target/release/zed-*.tar.gz
455
456 - name: Upload app bundle to release
457 uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # v1
458 with:
459 draft: true
460 prerelease: ${{ env.RELEASE_CHANNEL == 'preview' }}
461 files: |
462 target/zed-remote-server-linux-aarch64.gz
463 target/release/zed-linux-aarch64.tar.gz
464 env:
465 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
466
467 auto-release-preview:
468 name: Auto release preview
469 if: ${{ startsWith(github.ref, 'refs/tags/v') && endsWith(github.ref, '-pre') && !endsWith(github.ref, '.0-pre') }}
470 needs: [bundle-mac, bundle-linux-x86_x64, bundle-linux-aarch64]
471 runs-on:
472 - self-hosted
473 - bundle
474 steps:
475 - name: gh release
476 run: gh release edit $GITHUB_REF_NAME --draft=false
477 env:
478 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}