ci.yml

  1name: CI
  2
  3on:
  4  push:
  5    branches:
  6      - main
  7      - "v[0-9]+.[0-9]+.x"
  8    tags:
  9      - "v*"
 10  pull_request:
 11    branches:
 12      - "**"
 13
 14concurrency:
 15  # Allow only one workflow per any non-`main` branch.
 16  group: ${{ github.workflow }}-${{ github.ref_name }}-${{ github.ref_name == 'main' && github.sha || 'anysha' }}
 17  cancel-in-progress: true
 18
 19env:
 20  CARGO_TERM_COLOR: always
 21  CARGO_INCREMENTAL: 0
 22  RUST_BACKTRACE: 1
 23
 24jobs:
 25  style:
 26    name: Check formatting and spelling
 27    runs-on:
 28      - self-hosted
 29      - test
 30    steps:
 31      - name: Checkout repo
 32        uses: actions/checkout@v4
 33        with:
 34          clean: false
 35          submodules: "recursive"
 36          fetch-depth: 0
 37
 38      - name: Remove untracked files
 39        run: git clean -df
 40
 41      - name: Set up default .cargo/config.toml
 42        run: cp ./.cargo/ci-config.toml ~/.cargo/config.toml
 43
 44      - name: Check spelling
 45        run: |
 46          if ! which typos > /dev/null; then
 47            cargo install typos-cli
 48          fi
 49          typos
 50
 51      - name: Run style checks
 52        uses: ./.github/actions/check_style
 53
 54      - name: Check unused dependencies
 55        uses: bnjbvr/cargo-machete@main
 56
 57      - name: Check license generation
 58        run: script/generate-licenses /tmp/zed_licenses_output
 59
 60      - name: Ensure fresh merge
 61        shell: bash -euxo pipefail {0}
 62        run: |
 63          if [ -z "$GITHUB_BASE_REF" ];
 64          then
 65            echo "BUF_BASE_BRANCH=$(git merge-base origin/main HEAD)" >> $GITHUB_ENV
 66          else
 67            git checkout -B temp
 68            git merge -q origin/$GITHUB_BASE_REF -m "merge main into temp"
 69            echo "BUF_BASE_BRANCH=$GITHUB_BASE_REF" >> $GITHUB_ENV
 70          fi
 71
 72      - uses: bufbuild/buf-setup-action@v1
 73        with:
 74          version: v1.29.0
 75      - uses: bufbuild/buf-breaking-action@v1
 76        with:
 77          input: "crates/rpc/proto/"
 78          against: "https://github.com/${GITHUB_REPOSITORY}.git#branch=${BUF_BASE_BRANCH},subdir=crates/rpc/proto/"
 79
 80  macos_tests:
 81    name: (macOS) Run Clippy and tests
 82    runs-on:
 83      - self-hosted
 84      - test
 85    steps:
 86      - name: Checkout repo
 87        uses: actions/checkout@v4
 88        with:
 89          clean: false
 90          submodules: "recursive"
 91
 92      - name: cargo clippy
 93        run: cargo xtask clippy
 94
 95      - name: Run tests
 96        uses: ./.github/actions/run_tests
 97
 98      - name: Build collab
 99        run: cargo build -p collab
100
101      - name: Build other binaries and features
102        run: cargo build --workspace --bins --all-features; cargo check -p gpui --features "macos-blade"
103
104  # todo(linux): Actually run the tests
105  linux_tests:
106    name: (Linux) Run Clippy and tests
107    runs-on: ubuntu-latest
108    steps:
109      - name: Checkout repo
110        uses: actions/checkout@v4
111        with:
112          clean: false
113          submodules: "recursive"
114
115      - name: Cache dependencies
116        uses: swatinem/rust-cache@v2
117        with:
118          save-if: ${{ github.ref == 'refs/heads/main' }}
119
120      - name: configure linux
121        shell: bash -euxo pipefail {0}
122        run: script/linux
123
124      - name: cargo clippy
125        run: cargo xtask clippy
126
127      - name: Build Zed
128        run: cargo build -p zed
129
130  # todo(windows): Actually run the tests
131  windows_tests:
132    name: (Windows) Run Clippy and tests
133    runs-on: windows-latest
134    steps:
135      - name: Checkout repo
136        uses: actions/checkout@v4
137        with:
138          clean: false
139          submodules: "recursive"
140
141      - name: Cache dependencies
142        uses: swatinem/rust-cache@v2
143        with:
144          save-if: ${{ github.ref == 'refs/heads/main' }}
145
146      - name: cargo clippy
147        run: cargo xtask clippy
148
149      - name: Build Zed
150        run: cargo build -p zed
151
152  bundle-mac:
153    name: Create a macOS bundle
154    runs-on:
155      - self-hosted
156      - bundle
157    if: ${{ startsWith(github.ref, 'refs/tags/v') || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
158    needs: [macos_tests]
159    env:
160      MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }}
161      MACOS_CERTIFICATE_PASSWORD: ${{ secrets.MACOS_CERTIFICATE_PASSWORD }}
162      APPLE_NOTARIZATION_USERNAME: ${{ secrets.APPLE_NOTARIZATION_USERNAME }}
163      APPLE_NOTARIZATION_PASSWORD: ${{ secrets.APPLE_NOTARIZATION_PASSWORD }}
164      ZED_CLIENT_CHECKSUM_SEED: ${{ secrets.ZED_CLIENT_CHECKSUM_SEED }}
165      DIGITALOCEAN_SPACES_ACCESS_KEY: ${{ secrets.DIGITALOCEAN_SPACES_ACCESS_KEY }}
166      DIGITALOCEAN_SPACES_SECRET_KEY: ${{ secrets.DIGITALOCEAN_SPACES_SECRET_KEY }}
167    steps:
168      - name: Install Node
169        uses: actions/setup-node@v4
170        with:
171          node-version: "18"
172
173      - name: Checkout repo
174        uses: actions/checkout@v4
175        with:
176          clean: false
177          submodules: "recursive"
178
179      - name: Limit target directory size
180        run: script/clear-target-dir-if-larger-than 100
181
182      - name: Determine version and release channel
183        if: ${{ startsWith(github.ref, 'refs/tags/v') }}
184        run: |
185          set -eu
186
187          version=$(script/get-crate-version zed)
188          channel=$(cat crates/zed/RELEASE_CHANNEL)
189          echo "Publishing version: ${version} on release channel ${channel}"
190          echo "RELEASE_CHANNEL=${channel}" >> $GITHUB_ENV
191
192          expected_tag_name=""
193          case ${channel} in
194            stable)
195              expected_tag_name="v${version}";;
196            preview)
197              expected_tag_name="v${version}-pre";;
198            nightly)
199              expected_tag_name="v${version}-nightly";;
200            *)
201              echo "can't publish a release on channel ${channel}"
202              exit 1;;
203          esac
204          if [[ $GITHUB_REF_NAME != $expected_tag_name ]]; then
205            echo "invalid release tag ${GITHUB_REF_NAME}. expected ${expected_tag_name}"
206            exit 1
207          fi
208          script/draft-release-notes "$version" "$channel" > target/release-notes.md
209
210      - name: Generate license file
211        run: script/generate-licenses
212
213      - name: Create macOS app bundle
214        run: script/bundle-mac
215
216      - name: Rename single-architecture binaries
217        if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
218        run: |
219          mv target/aarch64-apple-darwin/release/Zed.dmg target/aarch64-apple-darwin/release/Zed-aarch64.dmg
220          mv target/x86_64-apple-darwin/release/Zed.dmg target/x86_64-apple-darwin/release/Zed-x86_64.dmg
221
222      - name: Upload app bundle (universal) to workflow run if main branch or specific label
223        uses: actions/upload-artifact@v4
224        if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
225        with:
226          name: Zed_${{ github.event.pull_request.head.sha || github.sha }}.dmg
227          path: target/release/Zed.dmg
228      - name: Upload app bundle (aarch64) to workflow run if main branch or specific label
229        uses: actions/upload-artifact@v4
230        if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
231        with:
232          name: Zed_${{ github.event.pull_request.head.sha || github.sha }}-aarch64.dmg
233          path: target/aarch64-apple-darwin/release/Zed-aarch64.dmg
234
235      - name: Upload app bundle (x86_64) to workflow run if main branch or specific label
236        uses: actions/upload-artifact@v4
237        if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
238        with:
239          name: Zed_${{ github.event.pull_request.head.sha || github.sha }}-x86_64.dmg
240          path: target/x86_64-apple-darwin/release/Zed-x86_64.dmg
241
242      - uses: softprops/action-gh-release@v1
243        name: Upload app bundle to release
244        if: ${{ env.RELEASE_CHANNEL == 'preview' || env.RELEASE_CHANNEL == 'stable' }}
245        with:
246          draft: true
247          prerelease: ${{ env.RELEASE_CHANNEL == 'preview' }}
248          files: |
249            target/aarch64-apple-darwin/release/Zed-aarch64.dmg
250            target/x86_64-apple-darwin/release/Zed-x86_64.dmg
251            target/release/Zed.dmg
252          body_file: target/release-notes.md
253        env:
254          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
255
256  bundle-deb:
257    name: Create a *.deb Linux bundle
258    runs-on: ubuntu-22.04 # keep the version fixed to avoid libc and dynamic linked library issues
259    if: ${{ startsWith(github.ref, 'refs/tags/v') || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
260    needs: [linux_tests]
261    env:
262      ZED_CLIENT_CHECKSUM_SEED: ${{ secrets.ZED_CLIENT_CHECKSUM_SEED }}
263      DIGITALOCEAN_SPACES_ACCESS_KEY: ${{ secrets.DIGITALOCEAN_SPACES_ACCESS_KEY }}
264      DIGITALOCEAN_SPACES_SECRET_KEY: ${{ secrets.DIGITALOCEAN_SPACES_SECRET_KEY }}
265    steps:
266      - name: Checkout repo
267        uses: actions/checkout@v4
268        with:
269          clean: false
270          submodules: "recursive"
271
272      - name: Cache dependencies
273        uses: swatinem/rust-cache@v2
274        with:
275          save-if: ${{ github.ref == 'refs/heads/main' }}
276
277      - name: Configure linux
278        shell: bash -euxo pipefail {0}
279        run: script/linux
280
281      - name: Determine version and release channel
282        if: ${{ startsWith(github.ref, 'refs/tags/v') }}
283        run: |
284          set -eu
285
286          version=$(script/get-crate-version zed)
287          channel=$(cat crates/zed/RELEASE_CHANNEL)
288          echo "Publishing version: ${version} on release channel ${channel}"
289          echo "RELEASE_CHANNEL=${channel}" >> $GITHUB_ENV
290
291          expected_tag_name=""
292          case ${channel} in
293            stable)
294              expected_tag_name="v${version}";;
295            preview)
296              expected_tag_name="v${version}-pre";;
297            nightly)
298              expected_tag_name="v${version}-nightly";;
299            *)
300              echo "can't publish a release on channel ${channel}"
301              exit 1;;
302          esac
303          if [[ $GITHUB_REF_NAME != $expected_tag_name ]]; then
304            echo "invalid release tag ${GITHUB_REF_NAME}. expected ${expected_tag_name}"
305            exit 1
306          fi
307
308      # TODO linux : Find a way to add licenses to the final bundle
309      # - name: Generate license file
310      #   run: script/generate-licenses
311
312      - name: Create Linux *.deb bundle
313        run: script/bundle-linux
314
315      - name: Upload app bundle to workflow run if main branch or specific label
316        uses: actions/upload-artifact@v4
317        if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
318        with:
319          name: Zed_${{ github.event.pull_request.head.sha || github.sha }}.deb
320          path: target/release/*.deb
321
322      # TODO linux : make it stable enough to be uploaded as a release
323      # - uses: softprops/action-gh-release@v1
324      #   name: Upload app bundle to release
325      #   if: ${{ env.RELEASE_CHANNEL == 'preview' || env.RELEASE_CHANNEL == 'stable' }}
326      #   with:
327      #     draft: true
328      #     prerelease: ${{ env.RELEASE_CHANNEL == 'preview' }}
329      #     files: target/release/Zed.dmg
330      #     body: ""
331      #   env:
332      #     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}