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