ci.yml

  1name: CI
  2
  3on:
  4  push:
  5    branches:
  6      - main
  7      - "v[0-9]+.[0-9]+.x"
  8    tags:
  9      - "v*"
 10    paths-ignore:
 11      - "docs/**"
 12  pull_request:
 13    branches:
 14      - "**"
 15    paths-ignore:
 16      - "docs/**"
 17      - ".github/workflows/community_*"
 18
 19concurrency:
 20  # Allow only one workflow per any non-`main` branch.
 21  group: ${{ github.workflow }}-${{ github.ref_name }}-${{ github.ref_name == 'main' && github.sha || 'anysha' }}
 22  cancel-in-progress: true
 23
 24env:
 25  CARGO_TERM_COLOR: always
 26  CARGO_INCREMENTAL: 0
 27  RUST_BACKTRACE: 1
 28  RUSTFLAGS: "-D warnings"
 29
 30jobs:
 31  migration_checks:
 32    name: Check Postgres and Protobuf migrations, mergability
 33    if: github.repository_owner == 'zed-industries'
 34    timeout-minutes: 60
 35    runs-on:
 36      - self-hosted
 37      - test
 38    steps:
 39      - name: Checkout repo
 40        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
 41        with:
 42          clean: false
 43          fetch-depth: 0 # fetch full history
 44
 45      - name: Remove untracked files
 46        run: git clean -df
 47
 48      - name: Find modified migrations
 49        shell: bash -euxo pipefail {0}
 50        run: |
 51          export SQUAWK_GITHUB_TOKEN=${{ github.token }}
 52          . ./script/squawk
 53
 54      - name: Ensure fresh merge
 55        shell: bash -euxo pipefail {0}
 56        run: |
 57          if [ -z "$GITHUB_BASE_REF" ];
 58          then
 59            echo "BUF_BASE_BRANCH=$(git merge-base origin/main HEAD)" >> $GITHUB_ENV
 60          else
 61            git checkout -B temp
 62            git merge -q origin/$GITHUB_BASE_REF -m "merge main into temp"
 63            echo "BUF_BASE_BRANCH=$GITHUB_BASE_REF" >> $GITHUB_ENV
 64          fi
 65
 66      - uses: bufbuild/buf-setup-action@v1
 67        with:
 68          version: v1.29.0
 69      - uses: bufbuild/buf-breaking-action@v1
 70        with:
 71          input: "crates/proto/proto/"
 72          against: "https://github.com/${GITHUB_REPOSITORY}.git#branch=${BUF_BASE_BRANCH},subdir=crates/proto/proto/"
 73
 74  style:
 75    timeout-minutes: 60
 76    name: Check formatting and spelling
 77    if: github.repository_owner == 'zed-industries'
 78    runs-on:
 79      - buildjet-8vcpu-ubuntu-2204
 80    steps:
 81      - name: Checkout repo
 82        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
 83
 84      - name: Run style checks
 85        uses: ./.github/actions/check_style
 86
 87      - name: Check for typos
 88        uses: crate-ci/typos@8e6a4285bcbde632c5d79900a7779746e8b7ea3f # v1.24.6
 89        with:
 90          config: ./typos.toml
 91
 92  macos_tests:
 93    timeout-minutes: 60
 94    name: (macOS) Run Clippy and tests
 95    if: github.repository_owner == 'zed-industries'
 96    runs-on:
 97      - self-hosted
 98      - test
 99    steps:
100      - name: Checkout repo
101        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
102        with:
103          clean: false
104
105      - name: cargo clippy
106        run: ./script/clippy
107
108      - name: Check unused dependencies
109        uses: bnjbvr/cargo-machete@main
110
111      - name: Check licenses
112        run: |
113          script/check-licenses
114          script/generate-licenses /tmp/zed_licenses_output
115
116      - name: Run tests
117        uses: ./.github/actions/run_tests
118
119      - name: Build collab
120        run: cargo build -p collab
121
122      - name: Build other binaries and features
123        run: |
124          cargo build --workspace --bins --all-features
125          cargo check -p gpui --features "macos-blade"
126          cargo build -p remote_server
127
128  linux_tests:
129    timeout-minutes: 60
130    name: (Linux) Run Clippy and tests
131    if: github.repository_owner == 'zed-industries'
132    runs-on:
133      - buildjet-16vcpu-ubuntu-2204
134    steps:
135      - name: Add Rust to the PATH
136        run: echo "$HOME/.cargo/bin" >> $GITHUB_PATH
137
138      - name: Checkout repo
139        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
140        with:
141          clean: false
142
143      - name: Cache dependencies
144        uses: swatinem/rust-cache@82a92a6e8fbeee089604da2575dc567ae9ddeaab # v2
145        with:
146          save-if: ${{ github.ref == 'refs/heads/main' }}
147          cache-provider: "buildjet"
148
149      - name: Install Linux dependencies
150        run: ./script/linux
151
152      - name: cargo clippy
153        run: ./script/clippy
154
155      - name: Run tests
156        uses: ./.github/actions/run_tests
157
158      - name: Build Zed
159        run: cargo build -p zed
160
161  build_remote_server:
162    timeout-minutes: 60
163    name: (Linux) Build Remote Server
164    if: github.repository_owner == 'zed-industries'
165    runs-on:
166      - buildjet-16vcpu-ubuntu-2204
167    steps:
168      - name: Add Rust to the PATH
169        run: echo "$HOME/.cargo/bin" >> $GITHUB_PATH
170
171      - name: Checkout repo
172        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
173        with:
174          clean: false
175
176      - name: Cache dependencies
177        uses: swatinem/rust-cache@82a92a6e8fbeee089604da2575dc567ae9ddeaab # v2
178        with:
179          save-if: ${{ github.ref == 'refs/heads/main' }}
180          cache-provider: "buildjet"
181
182      - name: Install Clang & Mold
183        run: ./script/remote-server && ./script/install-mold 2.34.0
184
185      - name: Build Remote Server
186        run: cargo build -p remote_server
187
188  # todo(windows): Actually run the tests
189  windows_tests:
190    timeout-minutes: 60
191    name: (Windows) Run Clippy and tests
192    if: github.repository_owner == 'zed-industries'
193    runs-on: hosted-windows-1
194    steps:
195      - name: Checkout repo
196        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
197        with:
198          clean: false
199
200      - name: Cache dependencies
201        uses: swatinem/rust-cache@82a92a6e8fbeee089604da2575dc567ae9ddeaab # v2
202        with:
203          save-if: ${{ github.ref == 'refs/heads/main' }}
204          cache-provider: "github"
205
206      - name: cargo clippy
207        # Windows can't run shell scripts, so we need to use `cargo xtask`.
208        run: cargo xtask clippy
209
210      - name: Build Zed
211        run: cargo build
212
213  bundle-mac:
214    timeout-minutes: 60
215    name: Create a macOS bundle
216    runs-on:
217      - self-hosted
218      - bundle
219    if: ${{ startsWith(github.ref, 'refs/tags/v') || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
220    needs: [macos_tests]
221    env:
222      MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }}
223      MACOS_CERTIFICATE_PASSWORD: ${{ secrets.MACOS_CERTIFICATE_PASSWORD }}
224      APPLE_NOTARIZATION_USERNAME: ${{ secrets.APPLE_NOTARIZATION_USERNAME }}
225      APPLE_NOTARIZATION_PASSWORD: ${{ secrets.APPLE_NOTARIZATION_PASSWORD }}
226      ZED_CLIENT_CHECKSUM_SEED: ${{ secrets.ZED_CLIENT_CHECKSUM_SEED }}
227      ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON: ${{ secrets.ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON }}
228      DIGITALOCEAN_SPACES_ACCESS_KEY: ${{ secrets.DIGITALOCEAN_SPACES_ACCESS_KEY }}
229      DIGITALOCEAN_SPACES_SECRET_KEY: ${{ secrets.DIGITALOCEAN_SPACES_SECRET_KEY }}
230    steps:
231      - name: Install Node
232        uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4
233        with:
234          node-version: "18"
235
236      - name: Checkout repo
237        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
238        with:
239          # We need to fetch more than one commit so that `script/draft-release-notes`
240          # is able to diff between the current and previous tag.
241          #
242          # 25 was chosen arbitrarily.
243          fetch-depth: 25
244          clean: false
245
246      - name: Limit target directory size
247        run: script/clear-target-dir-if-larger-than 100
248
249      - name: Determine version and release channel
250        if: ${{ startsWith(github.ref, 'refs/tags/v') }}
251        run: |
252          # This exports RELEASE_CHANNEL into env (GITHUB_ENV)
253          script/determine-release-channel
254
255      - name: Draft release notes
256        if: ${{ startsWith(github.ref, 'refs/tags/v') }}
257        run: |
258          mkdir -p target/
259          # Ignore any errors that occur while drafting release notes to not fail the build.
260          script/draft-release-notes "$version" "$channel" > target/release-notes.md || true
261
262      - name: Generate license file
263        run: script/generate-licenses
264
265      - name: Create macOS app bundle
266        run: script/bundle-mac
267
268      - name: Rename single-architecture binaries
269        if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
270        run: |
271          mv target/aarch64-apple-darwin/release/Zed.dmg target/aarch64-apple-darwin/release/Zed-aarch64.dmg
272          mv target/x86_64-apple-darwin/release/Zed.dmg target/x86_64-apple-darwin/release/Zed-x86_64.dmg
273
274      - name: Upload app bundle (universal) to workflow run if main branch or specific label
275        uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4
276        if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
277        with:
278          name: Zed_${{ github.event.pull_request.head.sha || github.sha }}.dmg
279          path: target/release/Zed.dmg
280      - name: Upload app bundle (aarch64) to workflow run if main branch or specific label
281        uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4
282        if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
283        with:
284          name: Zed_${{ github.event.pull_request.head.sha || github.sha }}-aarch64.dmg
285          path: target/aarch64-apple-darwin/release/Zed-aarch64.dmg
286
287      - name: Upload app bundle (x86_64) to workflow run if main branch or specific label
288        uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4
289        if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
290        with:
291          name: Zed_${{ github.event.pull_request.head.sha || github.sha }}-x86_64.dmg
292          path: target/x86_64-apple-darwin/release/Zed-x86_64.dmg
293
294      - uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # v1
295        name: Upload app bundle to release
296        if: ${{ env.RELEASE_CHANNEL == 'preview' || env.RELEASE_CHANNEL == 'stable' }}
297        with:
298          draft: true
299          prerelease: ${{ env.RELEASE_CHANNEL == 'preview' }}
300          files: |
301            target/zed-remote-server-macos-x86_64.gz
302            target/zed-remote-server-macos-aarch64.gz
303            target/aarch64-apple-darwin/release/Zed-aarch64.dmg
304            target/x86_64-apple-darwin/release/Zed-x86_64.dmg
305            target/release/Zed.dmg
306          body_path: target/release-notes.md
307        env:
308          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
309
310  bundle-linux:
311    timeout-minutes: 60
312    name: Create a Linux bundle
313    runs-on:
314      - buildjet-16vcpu-ubuntu-2004
315    if: ${{ startsWith(github.ref, 'refs/tags/v') || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
316    needs: [linux_tests]
317    env:
318      ZED_CLIENT_CHECKSUM_SEED: ${{ secrets.ZED_CLIENT_CHECKSUM_SEED }}
319      ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON: ${{ secrets.ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON }}
320    steps:
321      - name: Checkout repo
322        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
323        with:
324          clean: false
325
326      - name: Install Linux dependencies
327        run: ./script/linux && ./script/install-mold 2.34.0
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: Create Linux .tar.gz bundle
336        run: script/bundle-linux
337
338      - name: Upload Linux bundle to workflow run if main branch or specific label
339        uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4
340        if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
341        with:
342          name: zed-${{ github.event.pull_request.head.sha || github.sha }}-x86_64-unknown-linux-gnu.tar.gz
343          path: target/release/zed-*.tar.gz
344
345      - name: Upload app bundle to release
346        uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # v1
347        with:
348          draft: true
349          prerelease: ${{ env.RELEASE_CHANNEL == 'preview' }}
350          files: |
351            target/zed-remote-server-linux-x86_64.gz
352            target/release/zed-linux-x86_64.tar.gz
353          body: ""
354        env:
355          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
356
357  bundle-linux-aarch64: # this runs on ubuntu22.04
358    timeout-minutes: 60
359    name: Create arm64 Linux bundle
360    runs-on:
361      - buildjet-16vcpu-ubuntu-2204-arm
362    if: ${{ startsWith(github.ref, 'refs/tags/v') || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
363    needs: [linux_tests]
364    env:
365      ZED_CLIENT_CHECKSUM_SEED: ${{ secrets.ZED_CLIENT_CHECKSUM_SEED }}
366      ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON: ${{ secrets.ZED_CLOUD_PROVIDER_ADDITIONAL_MODELS_JSON }}
367    steps:
368      - name: Checkout repo
369        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
370        with:
371          clean: false
372
373      - name: Install Linux dependencies
374        run: ./script/linux
375
376      - name: Determine version and release channel
377        if: ${{ startsWith(github.ref, 'refs/tags/v') }}
378        run: |
379          # This exports RELEASE_CHANNEL into env (GITHUB_ENV)
380          script/determine-release-channel
381
382      - name: Create and upload Linux .tar.gz bundle
383        run: script/bundle-linux
384
385      - name: Upload Linux bundle to workflow run if main branch or specific label
386        uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4
387        if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
388        with:
389          name: zed-${{ github.event.pull_request.head.sha || github.sha }}-aarch64-unknown-linux-gnu.tar.gz
390          path: target/release/zed-*.tar.gz
391
392      - name: Upload app bundle to release
393        uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # v1
394        with:
395          draft: true
396          prerelease: ${{ env.RELEASE_CHANNEL == 'preview' }}
397          files: |
398            target/zed-remote-server-linux-aarch64.gz
399            target/release/zed-linux-aarch64.tar.gz
400          body: ""
401        env:
402          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}