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-${GITHUB_REF_NAME}.md";
155pub(crate) const COMPLIANCE_REPORT_ARTIFACT_PATH: &str =
156 "compliance-report-${{ github.ref_name }}.md";
157pub(crate) const COMPLIANCE_STEP_ID: &str = "run-compliance-check";
158const NEEDS_REVIEW_PULLS_URL: &str = "https://github.com/zed-industries/zed/pulls?q=is%3Apr+is%3Aclosed+label%3A%22PR+state%3Aneeds+review%22";
159
160pub(crate) enum ComplianceContext {
161 Release,
162 ReleaseNonBlocking,
163 Scheduled { tag_source: StepOutput },
164}
165
166pub(crate) fn add_compliance_notification_steps(
167 job: gh_workflow::Job,
168 context: ComplianceContext,
169) -> gh_workflow::Job {
170 let upload_step = upload_artifact(COMPLIANCE_REPORT_ARTIFACT_PATH)
171 .if_condition(Expression::new("always()"))
172 .when(matches!(context, ComplianceContext::Release), |step| {
173 step.add_with(("overwrite", true))
174 });
175
176 let (success_prefix, failure_prefix) = match context {
177 ComplianceContext::Release | ComplianceContext::ReleaseNonBlocking => {
178 ("✅ Compliance check passed", "❌ Compliance check failed")
179 }
180 ComplianceContext::Scheduled { .. } => (
181 "✅ Scheduled compliance check passed",
182 "⚠️ Scheduled compliance check failed",
183 ),
184 };
185
186 let script = formatdoc! {r#"
187 if [ "$COMPLIANCE_OUTCOME" == "success" ]; then
188 STATUS="{success_prefix} for $COMPLIANCE_TAG"
189 MESSAGE=$(printf "%s\n\nReport: %s" "$STATUS" "$ARTIFACT_URL")
190 else
191 STATUS="{failure_prefix} for $COMPLIANCE_TAG"
192 MESSAGE=$(printf "%s\n\nReport: %s\nPRs needing review: %s" "$STATUS" "$ARTIFACT_URL" "{NEEDS_REVIEW_PULLS_URL}")
193 fi
194
195 curl -X POST -H 'Content-type: application/json' \
196 --data "$(jq -n --arg text "$MESSAGE" '{{"text": $text}}')" \
197 "$SLACK_WEBHOOK"
198 "#,
199 };
200
201 let notification_step = Step::new("send_compliance_slack_notification")
202 .run(&script)
203 .if_condition(Expression::new("always()"))
204 .add_env(("SLACK_WEBHOOK", vars::SLACK_WEBHOOK_WORKFLOW_FAILURES))
205 .add_env((
206 "COMPLIANCE_OUTCOME",
207 format!("${{{{ steps.{COMPLIANCE_STEP_ID}.outcome }}}}"),
208 ))
209 .add_env((
210 "COMPLIANCE_TAG",
211 match context {
212 ComplianceContext::Release | ComplianceContext::ReleaseNonBlocking => {
213 Context::github().ref_name().to_string()
214 }
215 ComplianceContext::Scheduled { tag_source } => tag_source.to_string(),
216 },
217 ))
218 .add_env((
219 "ARTIFACT_URL",
220 format!("{CURRENT_ACTION_RUN_URL}#artifacts"),
221 ));
222
223 job.add_step(upload_step).add_step(notification_step)
224}
225
226fn run_compliance_check() -> Step<Run> {
227 named::bash(formatdoc! {r#"
228 cargo xtask compliance "$GITHUB_REF_NAME" --report-path "{COMPLIANCE_REPORT_PATH}"
229 "#,
230 })
231 .id(COMPLIANCE_STEP_ID)
232 .add_env(("GITHUB_APP_ID", vars::ZED_ZIPPY_APP_ID))
233 .add_env(("GITHUB_APP_KEY", vars::ZED_ZIPPY_APP_PRIVATE_KEY))
234 .continue_on_error(true)
235}
236
237fn compliance_check() -> NamedJob {
238 let job = release_job(&[])
239 .runs_on(runners::LINUX_SMALL)
240 .add_step(
241 steps::checkout_repo()
242 .with_full_history()
243 .with_ref(Context::github().ref_()),
244 )
245 .add_step(steps::cache_rust_dependencies_namespace())
246 .add_step(run_compliance_check());
247
248 named::job(add_compliance_notification_steps(
249 job,
250 ComplianceContext::ReleaseNonBlocking,
251 ))
252}
253
254fn validate_release_assets(deps: &[&NamedJob]) -> NamedJob {
255 let expected_assets: Vec<String> = assets::all().iter().map(|a| format!("\"{a}\"")).collect();
256 let expected_assets_json = format!("[{}]", expected_assets.join(", "));
257
258 let validation_script = formatdoc! {r#"
259 EXPECTED_ASSETS='{expected_assets_json}'
260 TAG="$GITHUB_REF_NAME"
261
262 ACTUAL_ASSETS=$(gh release view "$TAG" --repo=zed-industries/zed --json assets -q '[.assets[].name]')
263
264 MISSING_ASSETS=$(echo "$EXPECTED_ASSETS" | jq -r --argjson actual "$ACTUAL_ASSETS" '. - $actual | .[]')
265
266 if [ -n "$MISSING_ASSETS" ]; then
267 echo "Error: The following assets are missing from the release:"
268 echo "$MISSING_ASSETS"
269 exit 1
270 fi
271
272 echo "All expected assets are present in the release."
273 "#,
274 };
275
276 let job = dependant_job(deps)
277 .runs_on(runners::LINUX_SMALL)
278 .add_step(named::bash(&validation_script).add_env(("GITHUB_TOKEN", vars::GITHUB_TOKEN)))
279 .add_step(
280 steps::checkout_repo()
281 .with_full_history()
282 .with_ref(Context::github().ref_()),
283 )
284 .add_step(steps::cache_rust_dependencies_namespace())
285 .add_step(run_compliance_check());
286
287 named::job(add_compliance_notification_steps(
288 job,
289 ComplianceContext::Release,
290 ))
291}
292
293fn auto_release_preview(deps: &[&NamedJob]) -> NamedJob {
294 let (authenticate, token) = steps::authenticate_as_zippy().into();
295
296 named::job(
297 dependant_job(deps)
298 .runs_on(runners::LINUX_SMALL)
299 .cond(Expression::new(indoc::indoc!(
300 r#"startsWith(github.ref, 'refs/tags/v') && endsWith(github.ref, '-pre') && !endsWith(github.ref, '.0-pre')"#
301 )))
302 .add_step(authenticate)
303 .add_step(
304 steps::script(
305 r#"gh release edit "$GITHUB_REF_NAME" --repo=zed-industries/zed --draft=false"#,
306 )
307 .add_env(("GITHUB_TOKEN", &token)),
308 )
309 )
310}
311
312pub(crate) fn download_workflow_artifacts() -> Step<Use> {
313 named::uses(
314 "actions",
315 "download-artifact",
316 "018cc2cf5baa6db3ef3c5f8a56943fffe632ef53", // v6.0.0
317 )
318 .add_with(("path", "./artifacts/"))
319}
320
321pub(crate) fn prep_release_artifacts() -> Step<Run> {
322 let mut script_lines = vec!["mkdir -p release-artifacts/\n".to_string()];
323 for asset in assets::all() {
324 let mv_command = format!("mv ./artifacts/{asset}/{asset} release-artifacts/{asset}");
325 script_lines.push(mv_command)
326 }
327
328 named::bash(&script_lines.join("\n"))
329}
330
331fn upload_release_assets(deps: &[&NamedJob], bundle: &ReleaseBundleJobs) -> NamedJob {
332 let mut deps = deps.to_vec();
333 deps.extend(bundle.jobs());
334
335 named::job(
336 dependant_job(&deps)
337 .runs_on(runners::LINUX_MEDIUM)
338 .add_step(download_workflow_artifacts())
339 .add_step(steps::script("ls -lR ./artifacts"))
340 .add_step(prep_release_artifacts())
341 .add_step(
342 steps::script("gh release upload \"$GITHUB_REF_NAME\" --repo=zed-industries/zed release-artifacts/*")
343 .add_env(("GITHUB_TOKEN", vars::GITHUB_TOKEN)),
344 ),
345 )
346}
347
348fn create_draft_release() -> NamedJob {
349 fn generate_release_notes() -> Step<Run> {
350 named::bash(
351 r#"node --redirect-warnings=/dev/null ./script/draft-release-notes "$RELEASE_VERSION" "$RELEASE_CHANNEL" > target/release-notes.md"#,
352 )
353 }
354
355 fn create_release() -> Step<Run> {
356 named::bash("script/create-draft-release target/release-notes.md")
357 .add_env(("GITHUB_TOKEN", vars::GITHUB_TOKEN))
358 }
359
360 named::job(
361 release_job(&[])
362 .runs_on(runners::LINUX_SMALL)
363 // We need to fetch more than one commit so that `script/draft-release-notes`
364 // is able to diff between the current and previous tag.
365 //
366 // 25 was chosen arbitrarily.
367 .add_step(
368 steps::checkout_repo()
369 .with_custom_fetch_depth(25)
370 .with_ref(Context::github().ref_()),
371 )
372 .add_step(steps::script("script/determine-release-channel"))
373 .add_step(steps::script("mkdir -p target/"))
374 .add_step(generate_release_notes())
375 .add_step(create_release()),
376 )
377}
378
379pub(crate) fn push_release_update_notification(
380 create_draft_release_job: &NamedJob,
381 upload_assets_job: &NamedJob,
382 validate_assets_job: &NamedJob,
383 auto_release_preview: &NamedJob,
384 test_jobs: &[&NamedJob],
385 bundle_jobs: &ReleaseBundleJobs,
386) -> NamedJob {
387 fn env_name(name: &str) -> String {
388 format!("RESULT_{}", name.to_uppercase())
389 }
390
391 let all_job_names: Vec<&str> = test_jobs
392 .iter()
393 .map(|j| j.name.as_ref())
394 .chain(bundle_jobs.jobs().into_iter().map(|j| j.name.as_ref()))
395 .collect();
396
397 let env_entries = [
398 (
399 "DRAFT_RESULT".into(),
400 format!("${{{{ needs.{}.result }}}}", create_draft_release_job.name),
401 ),
402 (
403 "UPLOAD_RESULT".into(),
404 format!("${{{{ needs.{}.result }}}}", upload_assets_job.name),
405 ),
406 (
407 "VALIDATE_RESULT".into(),
408 format!("${{{{ needs.{}.result }}}}", validate_assets_job.name),
409 ),
410 (
411 "AUTO_RELEASE_RESULT".into(),
412 format!("${{{{ needs.{}.result }}}}", auto_release_preview.name),
413 ),
414 ("RUN_URL".into(), CURRENT_ACTION_RUN_URL.to_string()),
415 ]
416 .into_iter()
417 .chain(
418 all_job_names
419 .iter()
420 .map(|name| (env_name(name), format!("${{{{ needs.{name}.result }}}}"))),
421 );
422
423 let failure_checks = all_job_names
424 .iter()
425 .map(|name| {
426 format!(
427 "if [ \"${env_name}\" == \"failure\" ];then FAILED_JOBS=\"$FAILED_JOBS {name}\"; fi",
428 env_name = env_name(name)
429 )
430 })
431 .collect::<Vec<_>>()
432 .join("\n ");
433
434 let notification_script = formatdoc! {r#"
435 TAG="$GITHUB_REF_NAME"
436
437 if [ "$DRAFT_RESULT" == "failure" ]; then
438 echo "❌ Draft release creation failed for $TAG: $RUN_URL"
439 else
440 RELEASE_URL=$(gh release view "$TAG" --repo=zed-industries/zed --json url -q '.url')
441 if [ "$UPLOAD_RESULT" == "failure" ]; then
442 echo "❌ Release asset upload failed for $TAG: $RELEASE_URL"
443 elif [ "$UPLOAD_RESULT" == "cancelled" ] || [ "$UPLOAD_RESULT" == "skipped" ]; then
444 FAILED_JOBS=""
445 {failure_checks}
446 FAILED_JOBS=$(echo "$FAILED_JOBS" | xargs)
447 if [ "$UPLOAD_RESULT" == "cancelled" ]; then
448 if [ -n "$FAILED_JOBS" ]; then
449 echo "❌ Release job for $TAG was cancelled, most likely because tests \`$FAILED_JOBS\` failed: $RUN_URL"
450 else
451 echo "❌ Release job for $TAG was cancelled: $RUN_URL"
452 fi
453 else
454 if [ -n "$FAILED_JOBS" ]; then
455 echo "❌ Tests \`$FAILED_JOBS\` for $TAG failed: $RUN_URL"
456 else
457 echo "❌ Tests for $TAG failed: $RUN_URL"
458 fi
459 fi
460 elif [ "$VALIDATE_RESULT" == "failure" ]; then
461 echo "❌ Release asset validation failed for $TAG (missing assets): $RUN_URL"
462 elif [ "$AUTO_RELEASE_RESULT" == "success" ]; then
463 echo "✅ Release $TAG was auto-released successfully: $RELEASE_URL"
464 elif [ "$AUTO_RELEASE_RESULT" == "failure" ]; then
465 echo "❌ Auto release failed for $TAG: $RUN_URL"
466 else
467 echo "👀 Release $TAG sitting freshly baked in the oven and waiting to be published: $RELEASE_URL"
468 fi
469 fi
470 "#,
471 };
472
473 let mut all_deps: Vec<&NamedJob> = vec![
474 create_draft_release_job,
475 upload_assets_job,
476 validate_assets_job,
477 auto_release_preview,
478 ];
479 all_deps.extend(test_jobs.iter().copied());
480 all_deps.extend(bundle_jobs.jobs());
481
482 let mut job = dependant_job(&all_deps)
483 .runs_on(runners::LINUX_SMALL)
484 .cond(Expression::new("always()"));
485
486 for step in notify_slack(MessageType::Evaluated {
487 script: notification_script,
488 env: env_entries.collect(),
489 }) {
490 job = job.add_step(step);
491 }
492 named::job(job)
493}
494
495pub(crate) fn notify_on_failure(deps: &[&NamedJob]) -> NamedJob {
496 let failure_message = format!("❌ ${{{{ github.workflow }}}} failed: {CURRENT_ACTION_RUN_URL}");
497
498 let mut job = dependant_job(deps)
499 .runs_on(runners::LINUX_SMALL)
500 .cond(Expression::new("failure()"));
501
502 for step in notify_slack(MessageType::Static(failure_message)) {
503 job = job.add_step(step);
504 }
505 named::job(job)
506}
507
508pub(crate) enum MessageType {
509 Static(String),
510 Evaluated {
511 script: String,
512 env: Vec<(String, String)>,
513 },
514}
515
516fn notify_slack(message: MessageType) -> Vec<Step<Run>> {
517 match message {
518 MessageType::Static(message) => vec![send_slack_message(message)],
519 MessageType::Evaluated { script, env } => {
520 let (generate_step, generated_message) = generate_slack_message(script, env);
521
522 vec![
523 generate_step,
524 send_slack_message(generated_message.to_string()),
525 ]
526 }
527 }
528}
529
530fn generate_slack_message(
531 expression: String,
532 env: Vec<(String, String)>,
533) -> (Step<Run>, StepOutput) {
534 let script = formatdoc! {r#"
535 MESSAGE=$({expression})
536 echo "message=$MESSAGE" >> "$GITHUB_OUTPUT"
537 "#
538 };
539 let mut generate_step = named::bash(&script)
540 .id("generate-webhook-message")
541 .add_env(("GH_TOKEN", Context::github().token()));
542
543 for (name, value) in env {
544 generate_step = generate_step.add_env((name, value));
545 }
546
547 let output = StepOutput::new(&generate_step, "message");
548
549 (generate_step, output)
550}
551
552fn send_slack_message(message: String) -> Step<Run> {
553 named::bash(
554 r#"curl -X POST -H 'Content-type: application/json' --data "$(jq -n --arg text "$SLACK_MESSAGE" '{"text": $text}')" "$SLACK_WEBHOOK""#
555 )
556 .add_env(("SLACK_WEBHOOK", vars::SLACK_WEBHOOK_WORKFLOW_FAILURES))
557 .add_env(("SLACK_MESSAGE", message))
558}