ci.yml

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