1use gh_workflow::{ctx::Context, *};
2use indoc::{formatdoc, indoc};
3
4use crate::tasks::workflows::{
5 extension_tests::{self},
6 runners,
7 steps::{
8 self, BASH_SHELL, CommonJobConditions, DEFAULT_REPOSITORY_OWNER_GUARD, NamedJob,
9 RepositoryTarget, cache_rust_dependencies_namespace, checkout_repo, dependant_job,
10 generate_token, named,
11 },
12 vars::{
13 JobOutput, StepOutput, WorkflowInput, WorkflowSecret,
14 one_workflow_per_non_main_branch_and_token,
15 },
16};
17
18const VERSION_CHECK: &str =
19 r#"sed -n 's/^version = \"\(.*\)\"/\1/p' < extension.toml | tr -d '[:space:]'"#;
20
21// This is used by various extensions repos in the zed-extensions org to bump extension versions.
22pub(crate) fn extension_bump() -> Workflow {
23 let bump_type = WorkflowInput::string("bump-type", Some("patch".to_owned()));
24 // TODO: Ideally, this would have a default of `false`, but this is currently not
25 // supported in gh-workflows
26 let force_bump = WorkflowInput::bool("force-bump", None);
27 let working_directory = WorkflowInput::string("working-directory", Some(".".to_owned()));
28
29 let (app_id, app_secret) = extension_workflow_secrets();
30 let (check_version_changed, version_changed, current_version) = check_version_changed();
31
32 let version_changed = version_changed.as_job_output(&check_version_changed);
33 let current_version = current_version.as_job_output(&check_version_changed);
34
35 let dependencies = [&check_version_changed];
36 let bump_version = bump_extension_version(
37 &dependencies,
38 ¤t_version,
39 &bump_type,
40 &version_changed,
41 &force_bump,
42 &app_id,
43 &app_secret,
44 );
45 let (create_label, tag) = create_version_label(
46 &dependencies,
47 &version_changed,
48 ¤t_version,
49 &app_id,
50 &app_secret,
51 );
52 let tag = tag.as_job_output(&create_label);
53 let trigger_release = trigger_release(
54 &[&check_version_changed, &create_label],
55 tag,
56 &app_id,
57 &app_secret,
58 );
59
60 named::workflow()
61 .add_event(
62 Event::default().workflow_call(
63 WorkflowCall::default()
64 .add_input(bump_type.name, bump_type.call_input())
65 .add_input(force_bump.name, force_bump.call_input())
66 .add_input(working_directory.name, working_directory.call_input())
67 .secrets([
68 (app_id.name.to_owned(), app_id.secret_configuration()),
69 (
70 app_secret.name.to_owned(),
71 app_secret.secret_configuration(),
72 ),
73 ]),
74 ),
75 )
76 .concurrency(one_workflow_per_non_main_branch_and_token("extension-bump"))
77 .add_env(("CARGO_TERM_COLOR", "always"))
78 .add_env(("RUST_BACKTRACE", 1))
79 .add_env(("CARGO_INCREMENTAL", 0))
80 .add_env((
81 "ZED_EXTENSION_CLI_SHA",
82 extension_tests::ZED_EXTENSION_CLI_SHA,
83 ))
84 .add_job(check_version_changed.name, check_version_changed.job)
85 .add_job(bump_version.name, bump_version.job)
86 .add_job(create_label.name, create_label.job)
87 .add_job(trigger_release.name, trigger_release.job)
88}
89
90fn extension_job_defaults() -> Defaults {
91 Defaults::default().run(
92 RunDefaults::default()
93 .shell(BASH_SHELL)
94 .working_directory("${{ inputs.working-directory }}"),
95 )
96}
97
98fn check_version_changed() -> (NamedJob, StepOutput, StepOutput) {
99 let (compare_versions, version_changed, current_version) = compare_versions();
100
101 let job = Job::default()
102 .defaults(extension_job_defaults())
103 .with_repository_owner_guard()
104 .outputs([
105 (version_changed.name.to_owned(), version_changed.to_string()),
106 (
107 current_version.name.to_string(),
108 current_version.to_string(),
109 ),
110 ])
111 .runs_on(runners::LINUX_SMALL)
112 .timeout_minutes(1u32)
113 .add_step(steps::checkout_repo().with_full_history())
114 .add_step(compare_versions);
115
116 (named::job(job), version_changed, current_version)
117}
118
119fn create_version_label(
120 dependencies: &[&NamedJob],
121 version_changed_output: &JobOutput,
122 current_version: &JobOutput,
123 app_id: &WorkflowSecret,
124 app_secret: &WorkflowSecret,
125) -> (NamedJob, StepOutput) {
126 let (generate_token, generated_token) =
127 generate_token(&app_id.to_string(), &app_secret.to_string()).into();
128 let (determine_tag_step, tag) = determine_tag(current_version);
129 let job = steps::dependant_job(dependencies)
130 .defaults(extension_job_defaults())
131 .cond(Expression::new(format!(
132 "{DEFAULT_REPOSITORY_OWNER_GUARD} && github.event_name == 'push' && \
133 github.ref == 'refs/heads/main' && {version_changed} == 'true'",
134 version_changed = version_changed_output.expr(),
135 )))
136 .outputs([(tag.name.to_owned(), tag.to_string())])
137 .runs_on(runners::LINUX_SMALL)
138 .timeout_minutes(1u32)
139 .add_step(generate_token)
140 .add_step(steps::checkout_repo())
141 .add_step(determine_tag_step)
142 .add_step(create_version_tag(&tag, generated_token));
143
144 (named::job(job), tag)
145}
146
147fn create_version_tag(tag: &StepOutput, generated_token: StepOutput) -> Step<Use> {
148 named::uses("actions", "github-script", "v7").with(
149 Input::default()
150 .add(
151 "script",
152 formatdoc! {r#"
153 github.rest.git.createRef({{
154 owner: context.repo.owner,
155 repo: context.repo.repo,
156 ref: 'refs/tags/{tag}',
157 sha: context.sha
158 }})"#
159 },
160 )
161 .add("github-token", generated_token.to_string()),
162 )
163}
164
165fn determine_tag(current_version: &JobOutput) -> (Step<Run>, StepOutput) {
166 let step = named::bash(formatdoc! {r#"
167 EXTENSION_ID="$(sed -n 's/^id = "\(.*\)"/\1/p' < extension.toml | head -1 | tr -d '[:space:]')"
168
169 if [[ "$WORKING_DIR" == "." || -z "$WORKING_DIR" ]]; then
170 TAG="v${{CURRENT_VERSION}}"
171 else
172 TAG="${{EXTENSION_ID}}-v${{CURRENT_VERSION}}"
173 fi
174
175 echo "tag=${{TAG}}" >> "$GITHUB_OUTPUT"
176 "#})
177 .id("determine-tag")
178 .add_env(("CURRENT_VERSION", current_version.to_string()))
179 .add_env(("WORKING_DIR", "${{ inputs.working-directory }}"));
180
181 let tag = StepOutput::new(&step, "tag");
182 (step, tag)
183}
184
185/// Compares the current and previous commit and checks whether versions changed inbetween.
186pub(crate) fn compare_versions() -> (Step<Run>, StepOutput, StepOutput) {
187 let check_needs_bump = named::bash(formatdoc! {
188 r#"
189 CURRENT_VERSION="$({VERSION_CHECK})"
190
191 if [[ "$GITHUB_EVENT_NAME" == "pull_request" ]]; then
192 PR_FORK_POINT="$(git merge-base origin/main HEAD)"
193 git checkout "$PR_FORK_POINT"
194 else
195 git checkout "$(git log -1 --format=%H)"~1
196 fi
197
198 PARENT_COMMIT_VERSION="$({VERSION_CHECK})"
199
200 [[ "$CURRENT_VERSION" == "$PARENT_COMMIT_VERSION" ]] && \
201 echo "version_changed=false" >> "$GITHUB_OUTPUT" || \
202 echo "version_changed=true" >> "$GITHUB_OUTPUT"
203
204 echo "current_version=${{CURRENT_VERSION}}" >> "$GITHUB_OUTPUT"
205 "#
206 })
207 .id("compare-versions-check");
208
209 let version_changed = StepOutput::new(&check_needs_bump, "version_changed");
210 let current_version = StepOutput::new(&check_needs_bump, "current_version");
211
212 (check_needs_bump, version_changed, current_version)
213}
214
215fn bump_extension_version(
216 dependencies: &[&NamedJob],
217 current_version: &JobOutput,
218 bump_type: &WorkflowInput,
219 version_changed_output: &JobOutput,
220 force_bump_output: &WorkflowInput,
221 app_id: &WorkflowSecret,
222 app_secret: &WorkflowSecret,
223) -> NamedJob {
224 let (generate_token, generated_token) =
225 generate_token(&app_id.to_string(), &app_secret.to_string()).into();
226 let (bump_version, _new_version, title, body, branch_name) =
227 bump_version(current_version, bump_type);
228
229 let job = steps::dependant_job(dependencies)
230 .defaults(extension_job_defaults())
231 .cond(Expression::new(format!(
232 "{DEFAULT_REPOSITORY_OWNER_GUARD} &&\n({force_bump} == true || {version_changed} == 'false')",
233 force_bump = force_bump_output.expr(),
234 version_changed = version_changed_output.expr(),
235 )))
236 .runs_on(runners::LINUX_SMALL)
237 .timeout_minutes(5u32)
238 .add_step(generate_token)
239 .add_step(steps::checkout_repo())
240 .add_step(cache_rust_dependencies_namespace())
241 .add_step(install_bump_2_version())
242 .add_step(bump_version)
243 .add_step(create_pull_request(
244 title,
245 body,
246 generated_token,
247 branch_name,
248 ));
249
250 named::job(job)
251}
252
253fn install_bump_2_version() -> Step<Run> {
254 named::run(
255 runners::Platform::Linux,
256 "pip install bump2version --break-system-packages",
257 )
258}
259
260fn bump_version(
261 current_version: &JobOutput,
262 bump_type: &WorkflowInput,
263) -> (Step<Run>, StepOutput, StepOutput, StepOutput, StepOutput) {
264 let step = named::bash(formatdoc! {r#"
265 BUMP_FILES=("extension.toml")
266 if [[ -f "Cargo.toml" ]]; then
267 BUMP_FILES+=("Cargo.toml")
268 fi
269
270 bump2version \
271 --search "version = \"{{current_version}}"\" \
272 --replace "version = \"{{new_version}}"\" \
273 --current-version "$OLD_VERSION" \
274 --no-configured-files "$BUMP_TYPE" "${{BUMP_FILES[@]}}"
275
276 if [[ -f "Cargo.toml" ]]; then
277 cargo +stable update --workspace
278 fi
279
280 NEW_VERSION="$({VERSION_CHECK})"
281 EXTENSION_ID="$(sed -n 's/^id = "\(.*\)"/\1/p' < extension.toml | head -1 | tr -d '[:space:]')"
282 EXTENSION_NAME="$(sed -n 's/^name = "\(.*\)"/\1/p' < extension.toml | head -1 | tr -d '[:space:]')"
283
284 if [[ "$WORKING_DIR" == "." || -z "$WORKING_DIR" ]]; then
285 {{
286 echo "title=Bump version to ${{NEW_VERSION}}";
287 echo "body=This PR bumps the version of this extension to v${{NEW_VERSION}}";
288 echo "branch_name=zed-zippy-autobump";
289 }} >> "$GITHUB_OUTPUT"
290 else
291 {{
292 echo "title=${{EXTENSION_ID}}: Bump to v${{NEW_VERSION}}";
293 echo "body<<EOF";
294 echo "This PR bumps the version of the ${{EXTENSION_NAME}} extension to v${{NEW_VERSION}}.";
295 echo "";
296 echo "Release Notes:";
297 echo "";
298 echo "- N/A";
299 echo "EOF";
300 echo "branch_name=zed-zippy-${{EXTENSION_ID}}-autobump";
301 }} >> "$GITHUB_OUTPUT"
302 fi
303
304 echo "new_version=${{NEW_VERSION}}" >> "$GITHUB_OUTPUT"
305 "#
306 })
307 .id("bump-version")
308 .add_env(("OLD_VERSION", current_version.to_string()))
309 .add_env(("BUMP_TYPE", bump_type.to_string()))
310 .add_env(("WORKING_DIR", "${{ inputs.working-directory }}"));
311
312 let new_version = StepOutput::new(&step, "new_version");
313 let title = StepOutput::new(&step, "title");
314 let body = StepOutput::new(&step, "body");
315 let branch_name = StepOutput::new(&step, "branch_name");
316 (step, new_version, title, body, branch_name)
317}
318
319fn create_pull_request(
320 title: StepOutput,
321 body: StepOutput,
322 generated_token: StepOutput,
323 branch_name: StepOutput,
324) -> Step<Use> {
325 named::uses(
326 "peter-evans",
327 "create-pull-request",
328 "98357b18bf14b5342f975ff684046ec3b2a07725",
329 )
330 .with(
331 Input::default()
332 .add("title", title.to_string())
333 .add("body", body.to_string())
334 .add("commit-message", title.to_string())
335 .add("branch", branch_name.to_string())
336 .add(
337 "committer",
338 "zed-zippy[bot] <234243425+zed-zippy[bot]@users.noreply.github.com>",
339 )
340 .add("base", "main")
341 .add("delete-branch", true)
342 .add("token", generated_token.to_string())
343 .add("sign-commits", true)
344 .add("assignees", Context::github().actor().to_string()),
345 )
346}
347
348fn trigger_release(
349 dependencies: &[&NamedJob],
350 tag: JobOutput,
351 app_id: &WorkflowSecret,
352 app_secret: &WorkflowSecret,
353) -> NamedJob {
354 let extension_registry = RepositoryTarget::new("zed-industries", &["extensions"]);
355 let (generate_token, generated_token) =
356 generate_token(&app_id.to_string(), &app_secret.to_string())
357 .for_repository(extension_registry);
358 let (get_extension_id, extension_id) = get_extension_id();
359 let (release_action, pull_request_number) = release_action(extension_id, tag, &generated_token);
360
361 let job = dependant_job(dependencies)
362 .defaults(extension_job_defaults())
363 .with_repository_owner_guard()
364 .runs_on(runners::LINUX_SMALL)
365 .add_step(generate_token)
366 .add_step(checkout_repo())
367 .add_step(get_extension_id)
368 .add_step(release_action)
369 .add_step(enable_automerge_if_staff(
370 pull_request_number,
371 generated_token,
372 ));
373
374 named::job(job)
375}
376
377fn get_extension_id() -> (Step<Run>, StepOutput) {
378 let step = named::bash(indoc! {
379 r#"
380 EXTENSION_ID="$(sed -n 's/id = \"\(.*\)\"/\1/p' < extension.toml)"
381
382 echo "extension_id=${EXTENSION_ID}" >> "$GITHUB_OUTPUT"
383 "#})
384 .id("get-extension-id");
385
386 let extension_id = StepOutput::new(&step, "extension_id");
387
388 (step, extension_id)
389}
390
391fn release_action(
392 extension_id: StepOutput,
393 tag: JobOutput,
394 generated_token: &StepOutput,
395) -> (Step<Use>, StepOutput) {
396 let step = named::uses(
397 "huacnlee",
398 "zed-extension-action",
399 "82920ff0876879f65ffbcfa3403589114a8919c6",
400 )
401 .id("extension-update")
402 .add_with(("extension-name", extension_id.to_string()))
403 .add_with(("push-to", "zed-industries/extensions"))
404 .add_with(("tag", tag.to_string()))
405 .add_env(("COMMITTER_TOKEN", generated_token.to_string()));
406
407 let pull_request_number = StepOutput::new(&step, "pull-request-number");
408
409 (step, pull_request_number)
410}
411
412fn enable_automerge_if_staff(
413 pull_request_number: StepOutput,
414 generated_token: StepOutput,
415) -> Step<Use> {
416 named::uses("actions", "github-script", "v7")
417 .add_with(("github-token", generated_token.to_string()))
418 .add_with((
419 "script",
420 indoc! {r#"
421 const prNumber = process.env.PR_NUMBER;
422 if (!prNumber) {
423 console.log('No pull request number set, skipping automerge.');
424 return;
425 }
426
427 const author = process.env.GITHUB_ACTOR;
428 let isStaff = false;
429 try {
430 const response = await github.rest.teams.getMembershipForUserInOrg({
431 org: 'zed-industries',
432 team_slug: 'staff',
433 username: author
434 });
435 isStaff = response.data.state === 'active';
436 } catch (error) {
437 if (error.status !== 404) {
438 throw error;
439 }
440 }
441
442 if (!isStaff) {
443 console.log(`Actor ${author} is not a staff member, skipping automerge.`);
444 return;
445 }
446
447 // Assign staff member responsible for the bump
448 const pullNumber = parseInt(prNumber);
449
450 await github.rest.issues.addAssignees({
451 owner: 'zed-industries',
452 repo: 'extensions',
453 issue_number: pullNumber,
454 assignees: [author]
455 });
456 console.log(`Assigned ${author} to PR #${prNumber} in zed-industries/extensions`);
457
458 // Get the GraphQL node ID
459 const { data: pr } = await github.rest.pulls.get({
460 owner: 'zed-industries',
461 repo: 'extensions',
462 pull_number: pullNumber
463 });
464
465 await github.graphql(`
466 mutation($pullRequestId: ID!) {
467 enablePullRequestAutoMerge(input: { pullRequestId: $pullRequestId, mergeMethod: SQUASH }) {
468 pullRequest {
469 autoMergeRequest {
470 enabledAt
471 }
472 }
473 }
474 }
475 `, { pullRequestId: pr.node_id });
476
477 console.log(`Automerge enabled for PR #${prNumber} in zed-industries/extensions`);
478 "#},
479 ))
480 .add_env(("PR_NUMBER", pull_request_number.to_string()))
481}
482
483fn extension_workflow_secrets() -> (WorkflowSecret, WorkflowSecret) {
484 let app_id = WorkflowSecret::new("app-id", "The app ID used to create the PR");
485 let app_secret =
486 WorkflowSecret::new("app-secret", "The app secret for the corresponding app ID");
487
488 (app_id, app_secret)
489}