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