1use gh_workflow::{Event, Expression, Push, Run, Step, Use, Workflow, ctx::Context};
2use indoc::formatdoc;
3
4use crate::tasks::workflows::{
5 run_bundling::{bundle_linux, bundle_mac, bundle_windows, upload_artifact},
6 run_tests,
7 runners::{self, Arch, Platform},
8 steps::{self, FluentBuilder, NamedJob, dependant_job, named, release_job},
9 vars::{self, StepOutput, assets},
10};
11
12const CURRENT_ACTION_RUN_URL: &str =
13 "${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}";
14
15pub(crate) fn release() -> Workflow {
16 let macos_tests = run_tests::run_platform_tests_no_filter(Platform::Mac);
17 let linux_tests = run_tests::run_platform_tests_no_filter(Platform::Linux);
18 let windows_tests = run_tests::run_platform_tests_no_filter(Platform::Windows);
19 let macos_clippy = run_tests::clippy(Platform::Mac, None);
20 let linux_clippy = run_tests::clippy(Platform::Linux, None);
21 let windows_clippy = run_tests::clippy(Platform::Windows, None);
22 let check_scripts = run_tests::check_scripts();
23
24 let create_draft_release = create_draft_release();
25 let compliance = compliance_check();
26
27 let bundle = ReleaseBundleJobs {
28 linux_aarch64: bundle_linux(
29 Arch::AARCH64,
30 None,
31 &[&linux_tests, &linux_clippy, &check_scripts],
32 ),
33 linux_x86_64: bundle_linux(
34 Arch::X86_64,
35 None,
36 &[&linux_tests, &linux_clippy, &check_scripts],
37 ),
38 mac_aarch64: bundle_mac(
39 Arch::AARCH64,
40 None,
41 &[&macos_tests, &macos_clippy, &check_scripts],
42 ),
43 mac_x86_64: bundle_mac(
44 Arch::X86_64,
45 None,
46 &[&macos_tests, &macos_clippy, &check_scripts],
47 ),
48 windows_aarch64: bundle_windows(
49 Arch::AARCH64,
50 None,
51 &[&windows_tests, &windows_clippy, &check_scripts],
52 ),
53 windows_x86_64: bundle_windows(
54 Arch::X86_64,
55 None,
56 &[&windows_tests, &windows_clippy, &check_scripts],
57 ),
58 };
59
60 let upload_release_assets = upload_release_assets(&[&create_draft_release], &bundle);
61 let validate_release_assets = validate_release_assets(&[&upload_release_assets]);
62
63 let auto_release_preview = auto_release_preview(&[&validate_release_assets]);
64
65 let test_jobs = [
66 &macos_tests,
67 &linux_tests,
68 &windows_tests,
69 &macos_clippy,
70 &linux_clippy,
71 &windows_clippy,
72 &check_scripts,
73 ];
74 let push_slack_notification = push_release_update_notification(
75 &create_draft_release,
76 &upload_release_assets,
77 &validate_release_assets,
78 &auto_release_preview,
79 &test_jobs,
80 &bundle,
81 );
82
83 named::workflow()
84 .on(Event::default().push(Push::default().tags(vec!["v*".to_string()])))
85 .concurrency(vars::one_workflow_per_non_main_branch())
86 .add_env(("CARGO_TERM_COLOR", "always"))
87 .add_env(("RUST_BACKTRACE", "1"))
88 .add_job(macos_tests.name, macos_tests.job)
89 .add_job(linux_tests.name, linux_tests.job)
90 .add_job(windows_tests.name, windows_tests.job)
91 .add_job(macos_clippy.name, macos_clippy.job)
92 .add_job(linux_clippy.name, linux_clippy.job)
93 .add_job(windows_clippy.name, windows_clippy.job)
94 .add_job(check_scripts.name, check_scripts.job)
95 .add_job(create_draft_release.name, create_draft_release.job)
96 .add_job(compliance.name, compliance.job)
97 .map(|mut workflow| {
98 for job in bundle.into_jobs() {
99 workflow = workflow.add_job(job.name, job.job);
100 }
101 workflow
102 })
103 .add_job(upload_release_assets.name, upload_release_assets.job)
104 .add_job(validate_release_assets.name, validate_release_assets.job)
105 .add_job(auto_release_preview.name, auto_release_preview.job)
106 .add_job(push_slack_notification.name, push_slack_notification.job)
107}
108
109pub(crate) struct ReleaseBundleJobs {
110 pub linux_aarch64: NamedJob,
111 pub linux_x86_64: NamedJob,
112 pub mac_aarch64: NamedJob,
113 pub mac_x86_64: NamedJob,
114 pub windows_aarch64: NamedJob,
115 pub windows_x86_64: NamedJob,
116}
117
118impl ReleaseBundleJobs {
119 pub fn jobs(&self) -> Vec<&NamedJob> {
120 vec![
121 &self.linux_aarch64,
122 &self.linux_x86_64,
123 &self.mac_aarch64,
124 &self.mac_x86_64,
125 &self.windows_aarch64,
126 &self.windows_x86_64,
127 ]
128 }
129
130 pub fn into_jobs(self) -> Vec<NamedJob> {
131 vec![
132 self.linux_aarch64,
133 self.linux_x86_64,
134 self.mac_aarch64,
135 self.mac_x86_64,
136 self.windows_aarch64,
137 self.windows_x86_64,
138 ]
139 }
140}
141
142pub(crate) fn create_sentry_release() -> Step<Use> {
143 named::uses(
144 "getsentry",
145 "action-release",
146 "526942b68292201ac6bbb99b9a0747d4abee354c", // v3
147 )
148 .add_env(("SENTRY_ORG", "zed-dev"))
149 .add_env(("SENTRY_PROJECT", "zed"))
150 .add_env(("SENTRY_AUTH_TOKEN", vars::SENTRY_AUTH_TOKEN))
151 .add_with(("environment", "production"))
152}
153
154pub(crate) const COMPLIANCE_REPORT_PATH: &str = "compliance-report";
155const COMPLIANCE_REPORT_FILE: &str = "target/compliance-report.md";
156const NEEDS_REVIEW_PULLS_URL: &str = "https://github.com/zed-industries/zed/pulls?q=is%3Apr+is%3Aclosed+label%3A%22PR+state%3Aneeds+review%22";
157
158pub(crate) enum ComplianceContext {
159 Release,
160 Scheduled { tag_source: StepOutput },
161}
162
163pub(crate) fn add_compliance_notification_steps(
164 job: gh_workflow::Job,
165 context: ComplianceContext,
166 compliance_step_id: &str,
167) -> gh_workflow::Job {
168 let upload_step =
169 upload_artifact(COMPLIANCE_REPORT_FILE).if_condition(Expression::new("always()"));
170
171 let (success_prefix, failure_prefix) = match context {
172 ComplianceContext::Release => ("✅ Compliance check passed", "❌ Compliance check failed"),
173 ComplianceContext::Scheduled { .. } => (
174 "✅ Scheduled compliance check passed",
175 "⚠️ Scheduled compliance check failed",
176 ),
177 };
178
179 let script = formatdoc! {r#"
180 if [ "$COMPLIANCE_OUTCOME" == "success" ]; then
181 STATUS="{success_prefix} for $COMPLIANCE_TAG"
182 else
183 STATUS="{failure_prefix} for $COMPLIANCE_TAG"
184 fi
185
186 MESSAGE=$(printf "%s\n\nReport: %s\nPRs needing review: %s" "$STATUS" "$ARTIFACT_URL" "{NEEDS_REVIEW_PULLS_URL}")
187
188 curl -X POST -H 'Content-type: application/json' \
189 --data "$(jq -n --arg text "$MESSAGE" '{{"text": $text}}')" \
190 "$SLACK_WEBHOOK"
191 "#,
192 };
193
194 let notification_step = Step::new("send_compliance_slack_notification")
195 .run(&script)
196 .if_condition(Expression::new("always()"))
197 .add_env(("SLACK_WEBHOOK", vars::SLACK_WEBHOOK_WORKFLOW_FAILURES))
198 .add_env((
199 "COMPLIANCE_OUTCOME",
200 format!("${{{{ steps.{compliance_step_id}.outcome }}}}"),
201 ))
202 .add_env((
203 "COMPLIANCE_TAG",
204 match context {
205 ComplianceContext::Release => Context::github().ref_name().to_string(),
206 ComplianceContext::Scheduled { tag_source } => tag_source.to_string(),
207 },
208 ))
209 .add_env((
210 "ARTIFACT_URL",
211 format!("{CURRENT_ACTION_RUN_URL}#artifacts"),
212 ));
213
214 job.add_step(upload_step).add_step(notification_step)
215}
216
217fn compliance_check() -> NamedJob {
218 fn run_compliance_check() -> Step<Run> {
219 named::bash(formatdoc! {r#"
220 cargo xtask compliance "$GITHUB_REF_NAME" --report-path {COMPLIANCE_REPORT_PATH}
221 "#,
222 })
223 .id("run-compliance-check")
224 .add_env(("GITHUB_APP_ID", vars::ZED_ZIPPY_APP_ID))
225 .add_env(("GITHUB_APP_KEY", vars::ZED_ZIPPY_APP_PRIVATE_KEY))
226 }
227
228 let job = release_job(&[])
229 .runs_on(runners::LINUX_SMALL)
230 .add_step(
231 steps::checkout_repo()
232 .with_full_history()
233 .with_ref(Context::github().ref_()),
234 )
235 .add_step(steps::cache_rust_dependencies_namespace())
236 .add_step(run_compliance_check());
237
238 named::job(add_compliance_notification_steps(
239 job,
240 ComplianceContext::Release,
241 "run-compliance-check",
242 ))
243}
244
245fn validate_release_assets(deps: &[&NamedJob]) -> NamedJob {
246 let expected_assets: Vec<String> = assets::all().iter().map(|a| format!("\"{a}\"")).collect();
247 let expected_assets_json = format!("[{}]", expected_assets.join(", "));
248
249 let validation_script = formatdoc! {r#"
250 EXPECTED_ASSETS='{expected_assets_json}'
251 TAG="$GITHUB_REF_NAME"
252
253 ACTUAL_ASSETS=$(gh release view "$TAG" --repo=zed-industries/zed --json assets -q '[.assets[].name]')
254
255 MISSING_ASSETS=$(echo "$EXPECTED_ASSETS" | jq -r --argjson actual "$ACTUAL_ASSETS" '. - $actual | .[]')
256
257 if [ -n "$MISSING_ASSETS" ]; then
258 echo "Error: The following assets are missing from the release:"
259 echo "$MISSING_ASSETS"
260 exit 1
261 fi
262
263 echo "All expected assets are present in the release."
264 "#,
265 };
266
267 fn run_post_upload_compliance_check() -> Step<Run> {
268 named::bash(formatdoc! {r#"
269 cargo xtask compliance "$GITHUB_REF_NAME" --report-path {COMPLIANCE_REPORT_PATH}
270 "#,
271 })
272 .id("run-post-upload-compliance-check")
273 .add_env(("GITHUB_APP_ID", vars::ZED_ZIPPY_APP_ID))
274 .add_env(("GITHUB_APP_KEY", vars::ZED_ZIPPY_APP_PRIVATE_KEY))
275 }
276
277 let job = dependant_job(deps)
278 .runs_on(runners::LINUX_SMALL)
279 .add_step(named::bash(&validation_script).add_env(("GITHUB_TOKEN", vars::GITHUB_TOKEN)))
280 .add_step(
281 steps::checkout_repo()
282 .with_full_history()
283 .with_ref("${{ github.ref }}"),
284 )
285 .add_step(steps::cache_rust_dependencies_namespace())
286 .add_step(run_post_upload_compliance_check());
287
288 named::job(add_compliance_notification_steps(
289 job,
290 ComplianceContext::Release,
291 "run-post-upload-compliance-check",
292 ))
293}
294
295fn auto_release_preview(deps: &[&NamedJob]) -> NamedJob {
296 let (authenticate, token) = steps::authenticate_as_zippy().into();
297
298 named::job(
299 dependant_job(deps)
300 .runs_on(runners::LINUX_SMALL)
301 .cond(Expression::new(indoc::indoc!(
302 r#"startsWith(github.ref, 'refs/tags/v') && endsWith(github.ref, '-pre') && !endsWith(github.ref, '.0-pre')"#
303 )))
304 .add_step(authenticate)
305 .add_step(
306 steps::script(
307 r#"gh release edit "$GITHUB_REF_NAME" --repo=zed-industries/zed --draft=false"#,
308 )
309 .add_env(("GITHUB_TOKEN", &token)),
310 )
311 )
312}
313
314pub(crate) fn download_workflow_artifacts() -> Step<Use> {
315 named::uses(
316 "actions",
317 "download-artifact",
318 "018cc2cf5baa6db3ef3c5f8a56943fffe632ef53", // v6.0.0
319 )
320 .add_with(("path", "./artifacts/"))
321}
322
323pub(crate) fn prep_release_artifacts() -> Step<Run> {
324 let mut script_lines = vec!["mkdir -p release-artifacts/\n".to_string()];
325 for asset in assets::all() {
326 let mv_command = format!("mv ./artifacts/{asset}/{asset} release-artifacts/{asset}");
327 script_lines.push(mv_command)
328 }
329
330 named::bash(&script_lines.join("\n"))
331}
332
333fn upload_release_assets(deps: &[&NamedJob], bundle: &ReleaseBundleJobs) -> NamedJob {
334 let mut deps = deps.to_vec();
335 deps.extend(bundle.jobs());
336
337 named::job(
338 dependant_job(&deps)
339 .runs_on(runners::LINUX_MEDIUM)
340 .add_step(download_workflow_artifacts())
341 .add_step(steps::script("ls -lR ./artifacts"))
342 .add_step(prep_release_artifacts())
343 .add_step(
344 steps::script("gh release upload \"$GITHUB_REF_NAME\" --repo=zed-industries/zed release-artifacts/*")
345 .add_env(("GITHUB_TOKEN", vars::GITHUB_TOKEN)),
346 ),
347 )
348}
349
350fn create_draft_release() -> NamedJob {
351 fn generate_release_notes() -> Step<Run> {
352 named::bash(
353 r#"node --redirect-warnings=/dev/null ./script/draft-release-notes "$RELEASE_VERSION" "$RELEASE_CHANNEL" > target/release-notes.md"#,
354 )
355 }
356
357 fn create_release() -> Step<Run> {
358 named::bash("script/create-draft-release target/release-notes.md")
359 .add_env(("GITHUB_TOKEN", vars::GITHUB_TOKEN))
360 }
361
362 named::job(
363 release_job(&[])
364 .runs_on(runners::LINUX_SMALL)
365 // We need to fetch more than one commit so that `script/draft-release-notes`
366 // is able to diff between the current and previous tag.
367 //
368 // 25 was chosen arbitrarily.
369 .add_step(
370 steps::checkout_repo()
371 .with_custom_fetch_depth(25)
372 .with_ref(Context::github().ref_()),
373 )
374 .add_step(steps::script("script/determine-release-channel"))
375 .add_step(steps::script("mkdir -p target/"))
376 .add_step(generate_release_notes())
377 .add_step(create_release()),
378 )
379}
380
381pub(crate) fn push_release_update_notification(
382 create_draft_release_job: &NamedJob,
383 upload_assets_job: &NamedJob,
384 validate_assets_job: &NamedJob,
385 auto_release_preview: &NamedJob,
386 test_jobs: &[&NamedJob],
387 bundle_jobs: &ReleaseBundleJobs,
388) -> NamedJob {
389 fn env_name(name: &str) -> String {
390 format!("RESULT_{}", name.to_uppercase())
391 }
392
393 let all_job_names: Vec<&str> = test_jobs
394 .iter()
395 .map(|j| j.name.as_ref())
396 .chain(bundle_jobs.jobs().into_iter().map(|j| j.name.as_ref()))
397 .collect();
398
399 let env_entries = [
400 (
401 "DRAFT_RESULT".into(),
402 format!("${{{{ needs.{}.result }}}}", create_draft_release_job.name),
403 ),
404 (
405 "UPLOAD_RESULT".into(),
406 format!("${{{{ needs.{}.result }}}}", upload_assets_job.name),
407 ),
408 (
409 "VALIDATE_RESULT".into(),
410 format!("${{{{ needs.{}.result }}}}", validate_assets_job.name),
411 ),
412 (
413 "AUTO_RELEASE_RESULT".into(),
414 format!("${{{{ needs.{}.result }}}}", auto_release_preview.name),
415 ),
416 ("RUN_URL".into(), CURRENT_ACTION_RUN_URL.to_string()),
417 ]
418 .into_iter()
419 .chain(
420 all_job_names
421 .iter()
422 .map(|name| (env_name(name), format!("${{{{ needs.{name}.result }}}}"))),
423 );
424
425 let failure_checks = all_job_names
426 .iter()
427 .map(|name| {
428 format!(
429 "if [ \"${env_name}\" == \"failure\" ];then FAILED_JOBS=\"$FAILED_JOBS {name}\"; fi",
430 env_name = env_name(name)
431 )
432 })
433 .collect::<Vec<_>>()
434 .join("\n ");
435
436 let notification_script = formatdoc! {r#"
437 TAG="$GITHUB_REF_NAME"
438
439 if [ "$DRAFT_RESULT" == "failure" ]; then
440 echo "❌ Draft release creation failed for $TAG: $RUN_URL"
441 else
442 RELEASE_URL=$(gh release view "$TAG" --repo=zed-industries/zed --json url -q '.url')
443 if [ "$UPLOAD_RESULT" == "failure" ]; then
444 echo "❌ Release asset upload failed for $TAG: $RELEASE_URL"
445 elif [ "$UPLOAD_RESULT" == "cancelled" ] || [ "$UPLOAD_RESULT" == "skipped" ]; then
446 FAILED_JOBS=""
447 {failure_checks}
448 FAILED_JOBS=$(echo "$FAILED_JOBS" | xargs)
449 if [ "$UPLOAD_RESULT" == "cancelled" ]; then
450 if [ -n "$FAILED_JOBS" ]; then
451 echo "❌ Release job for $TAG was cancelled, most likely because tests \`$FAILED_JOBS\` failed: $RUN_URL"
452 else
453 echo "❌ Release job for $TAG was cancelled: $RUN_URL"
454 fi
455 else
456 if [ -n "$FAILED_JOBS" ]; then
457 echo "❌ Tests \`$FAILED_JOBS\` for $TAG failed: $RUN_URL"
458 else
459 echo "❌ Tests for $TAG failed: $RUN_URL"
460 fi
461 fi
462 elif [ "$VALIDATE_RESULT" == "failure" ]; then
463 echo "❌ Release asset validation failed for $TAG (missing assets): $RUN_URL"
464 elif [ "$AUTO_RELEASE_RESULT" == "success" ]; then
465 echo "✅ Release $TAG was auto-released successfully: $RELEASE_URL"
466 elif [ "$AUTO_RELEASE_RESULT" == "failure" ]; then
467 echo "❌ Auto release failed for $TAG: $RUN_URL"
468 else
469 echo "👀 Release $TAG sitting freshly baked in the oven and waiting to be published: $RELEASE_URL"
470 fi
471 fi
472 "#,
473 };
474
475 let mut all_deps: Vec<&NamedJob> = vec![
476 create_draft_release_job,
477 upload_assets_job,
478 validate_assets_job,
479 auto_release_preview,
480 ];
481 all_deps.extend(test_jobs.iter().copied());
482 all_deps.extend(bundle_jobs.jobs());
483
484 let mut job = dependant_job(&all_deps)
485 .runs_on(runners::LINUX_SMALL)
486 .cond(Expression::new("always()"));
487
488 for step in notify_slack(MessageType::Evaluated {
489 script: notification_script,
490 env: env_entries.collect(),
491 }) {
492 job = job.add_step(step);
493 }
494 named::job(job)
495}
496
497pub(crate) fn notify_on_failure(deps: &[&NamedJob]) -> NamedJob {
498 let failure_message = format!("❌ ${{{{ github.workflow }}}} failed: {CURRENT_ACTION_RUN_URL}");
499
500 let mut job = dependant_job(deps)
501 .runs_on(runners::LINUX_SMALL)
502 .cond(Expression::new("failure()"));
503
504 for step in notify_slack(MessageType::Static(failure_message)) {
505 job = job.add_step(step);
506 }
507 named::job(job)
508}
509
510pub(crate) enum MessageType {
511 Static(String),
512 Evaluated {
513 script: String,
514 env: Vec<(String, String)>,
515 },
516}
517
518fn notify_slack(message: MessageType) -> Vec<Step<Run>> {
519 match message {
520 MessageType::Static(message) => vec![send_slack_message(message)],
521 MessageType::Evaluated { script, env } => {
522 let (generate_step, generated_message) = generate_slack_message(script, env);
523
524 vec![
525 generate_step,
526 send_slack_message(generated_message.to_string()),
527 ]
528 }
529 }
530}
531
532fn generate_slack_message(
533 expression: String,
534 env: Vec<(String, String)>,
535) -> (Step<Run>, StepOutput) {
536 let script = formatdoc! {r#"
537 MESSAGE=$({expression})
538 echo "message=$MESSAGE" >> "$GITHUB_OUTPUT"
539 "#
540 };
541 let mut generate_step = named::bash(&script)
542 .id("generate-webhook-message")
543 .add_env(("GH_TOKEN", Context::github().token()));
544
545 for (name, value) in env {
546 generate_step = generate_step.add_env((name, value));
547 }
548
549 let output = StepOutput::new(&generate_step, "message");
550
551 (generate_step, output)
552}
553
554fn send_slack_message(message: String) -> Step<Run> {
555 named::bash(
556 r#"curl -X POST -H 'Content-type: application/json' --data "$(jq -n --arg text "$SLACK_MESSAGE" '{"text": $text}')" "$SLACK_WEBHOOK""#
557 )
558 .add_env(("SLACK_WEBHOOK", vars::SLACK_WEBHOOK_WORKFLOW_FAILURES))
559 .add_env(("SLACK_MESSAGE", message))
560}