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 # We need to fetch tags so that `script/draft-release-notes`
177 # is able to diff between the current and previous tag.
178 fetch-tags: true
179 clean: false
180 submodules: "recursive"
181
182 - name: Limit target directory size
183 run: script/clear-target-dir-if-larger-than 100
184
185 - name: Determine version and release channel
186 if: ${{ startsWith(github.ref, 'refs/tags/v') }}
187 run: |
188 set -eu
189
190 version=$(script/get-crate-version zed)
191 channel=$(cat crates/zed/RELEASE_CHANNEL)
192 echo "Publishing version: ${version} on release channel ${channel}"
193 echo "RELEASE_CHANNEL=${channel}" >> $GITHUB_ENV
194
195 expected_tag_name=""
196 case ${channel} in
197 stable)
198 expected_tag_name="v${version}";;
199 preview)
200 expected_tag_name="v${version}-pre";;
201 nightly)
202 expected_tag_name="v${version}-nightly";;
203 *)
204 echo "can't publish a release on channel ${channel}"
205 exit 1;;
206 esac
207 if [[ $GITHUB_REF_NAME != $expected_tag_name ]]; then
208 echo "invalid release tag ${GITHUB_REF_NAME}. expected ${expected_tag_name}"
209 exit 1
210 fi
211 mkdir -p target/
212 script/draft-release-notes "$version" "$channel" > target/release-notes.md
213
214 - name: Generate license file
215 run: script/generate-licenses
216
217 - name: Create macOS app bundle
218 run: script/bundle-mac
219
220 - name: Rename single-architecture binaries
221 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
222 run: |
223 mv target/aarch64-apple-darwin/release/Zed.dmg target/aarch64-apple-darwin/release/Zed-aarch64.dmg
224 mv target/x86_64-apple-darwin/release/Zed.dmg target/x86_64-apple-darwin/release/Zed-x86_64.dmg
225
226 - name: Upload app bundle (universal) to workflow run if main branch or specific label
227 uses: actions/upload-artifact@v4
228 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
229 with:
230 name: Zed_${{ github.event.pull_request.head.sha || github.sha }}.dmg
231 path: target/release/Zed.dmg
232 - name: Upload app bundle (aarch64) to workflow run if main branch or specific label
233 uses: actions/upload-artifact@v4
234 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
235 with:
236 name: Zed_${{ github.event.pull_request.head.sha || github.sha }}-aarch64.dmg
237 path: target/aarch64-apple-darwin/release/Zed-aarch64.dmg
238
239 - name: Upload app bundle (x86_64) to workflow run if main branch or specific label
240 uses: actions/upload-artifact@v4
241 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
242 with:
243 name: Zed_${{ github.event.pull_request.head.sha || github.sha }}-x86_64.dmg
244 path: target/x86_64-apple-darwin/release/Zed-x86_64.dmg
245
246 - uses: softprops/action-gh-release@v1
247 name: Upload app bundle to release
248 if: ${{ env.RELEASE_CHANNEL == 'preview' || env.RELEASE_CHANNEL == 'stable' }}
249 with:
250 draft: true
251 prerelease: ${{ env.RELEASE_CHANNEL == 'preview' }}
252 files: |
253 target/aarch64-apple-darwin/release/Zed-aarch64.dmg
254 target/x86_64-apple-darwin/release/Zed-x86_64.dmg
255 target/release/Zed.dmg
256 body_file: target/release-notes.md
257 env:
258 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
259
260 bundle-deb:
261 name: Create a *.deb Linux bundle
262 runs-on: ubuntu-22.04 # keep the version fixed to avoid libc and dynamic linked library issues
263 if: ${{ startsWith(github.ref, 'refs/tags/v') || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
264 needs: [linux_tests]
265 env:
266 ZED_CLIENT_CHECKSUM_SEED: ${{ secrets.ZED_CLIENT_CHECKSUM_SEED }}
267 DIGITALOCEAN_SPACES_ACCESS_KEY: ${{ secrets.DIGITALOCEAN_SPACES_ACCESS_KEY }}
268 DIGITALOCEAN_SPACES_SECRET_KEY: ${{ secrets.DIGITALOCEAN_SPACES_SECRET_KEY }}
269 steps:
270 - name: Checkout repo
271 uses: actions/checkout@v4
272 with:
273 clean: false
274 submodules: "recursive"
275
276 - name: Cache dependencies
277 uses: swatinem/rust-cache@v2
278 with:
279 save-if: ${{ github.ref == 'refs/heads/main' }}
280
281 - name: Configure linux
282 shell: bash -euxo pipefail {0}
283 run: script/linux
284
285 - name: Determine version and release channel
286 if: ${{ startsWith(github.ref, 'refs/tags/v') }}
287 run: |
288 set -eu
289
290 version=$(script/get-crate-version zed)
291 channel=$(cat crates/zed/RELEASE_CHANNEL)
292 echo "Publishing version: ${version} on release channel ${channel}"
293 echo "RELEASE_CHANNEL=${channel}" >> $GITHUB_ENV
294
295 expected_tag_name=""
296 case ${channel} in
297 stable)
298 expected_tag_name="v${version}";;
299 preview)
300 expected_tag_name="v${version}-pre";;
301 nightly)
302 expected_tag_name="v${version}-nightly";;
303 *)
304 echo "can't publish a release on channel ${channel}"
305 exit 1;;
306 esac
307 if [[ $GITHUB_REF_NAME != $expected_tag_name ]]; then
308 echo "invalid release tag ${GITHUB_REF_NAME}. expected ${expected_tag_name}"
309 exit 1
310 fi
311
312 # TODO linux : Find a way to add licenses to the final bundle
313 # - name: Generate license file
314 # run: script/generate-licenses
315
316 - name: Create Linux *.deb bundle
317 run: script/bundle-linux
318
319 - name: Upload app bundle to workflow run if main branch or specific label
320 uses: actions/upload-artifact@v4
321 if: ${{ github.ref == 'refs/heads/main' }} || contains(github.event.pull_request.labels.*.name, 'run-bundling') }}
322 with:
323 name: Zed_${{ github.event.pull_request.head.sha || github.sha }}.deb
324 path: target/release/*.deb
325
326 # TODO linux : make it stable enough to be uploaded as a release
327 # - uses: softprops/action-gh-release@v1
328 # name: Upload app bundle to release
329 # if: ${{ env.RELEASE_CHANNEL == 'preview' || env.RELEASE_CHANNEL == 'stable' }}
330 # with:
331 # draft: true
332 # prerelease: ${{ env.RELEASE_CHANNEL == 'preview' }}
333 # files: target/release/Zed.dmg
334 # body: ""
335 # env:
336 # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}