1use gh_workflow::*;
2
3use crate::tasks::workflows::{
4 runners,
5 steps::{self, FluentBuilder, NamedJob, named},
6 vars::{self, StepOutput, WorkflowInput},
7};
8
9pub fn autofix_pr() -> Workflow {
10 let pr_number = WorkflowInput::string("pr_number", None);
11 let run_clippy = WorkflowInput::bool("run_clippy", Some(true));
12 let run_autofix = run_autofix(&pr_number, &run_clippy);
13 let commit_changes = commit_changes(&pr_number, &run_autofix);
14 named::workflow()
15 .run_name(format!("autofix PR #{pr_number}"))
16 .on(Event::default().workflow_dispatch(
17 WorkflowDispatch::default()
18 .add_input(pr_number.name, pr_number.input())
19 .add_input(run_clippy.name, run_clippy.input()),
20 ))
21 .concurrency(
22 Concurrency::new(Expression::new(format!(
23 "${{{{ github.workflow }}}}-{pr_number}"
24 )))
25 .cancel_in_progress(true),
26 )
27 .add_job(run_autofix.name.clone(), run_autofix.job)
28 .add_job(commit_changes.name, commit_changes.job)
29}
30
31const PATCH_ARTIFACT_NAME: &str = "autofix-patch";
32const PATCH_FILE_PATH: &str = "autofix.patch";
33
34fn upload_patch_artifact() -> Step<Use> {
35 Step::new(format!("upload artifact {}", PATCH_ARTIFACT_NAME))
36 .uses(
37 "actions",
38 "upload-artifact",
39 "330a01c490aca151604b8cf639adc76d48f6c5d4", // v5
40 )
41 .add_with(("name", PATCH_ARTIFACT_NAME))
42 .add_with(("path", PATCH_FILE_PATH))
43 .add_with(("if-no-files-found", "ignore"))
44 .add_with(("retention-days", "1"))
45}
46
47fn download_patch_artifact() -> Step<Use> {
48 named::uses(
49 "actions",
50 "download-artifact",
51 "018cc2cf5baa6db3ef3c5f8a56943fffe632ef53", // v6.0.0
52 )
53 .add_with(("name", PATCH_ARTIFACT_NAME))
54}
55
56fn run_autofix(pr_number: &WorkflowInput, run_clippy: &WorkflowInput) -> NamedJob {
57 fn checkout_pr(pr_number: &WorkflowInput) -> Step<Run> {
58 named::bash(&format!("gh pr checkout {pr_number}"))
59 .add_env(("GITHUB_TOKEN", vars::GITHUB_TOKEN))
60 }
61
62 fn run_cargo_fmt() -> Step<Run> {
63 named::bash("cargo fmt --all")
64 }
65
66 fn run_clippy_fix() -> Step<Run> {
67 named::bash(
68 "cargo clippy --workspace --release --all-targets --all-features --fix --allow-dirty --allow-staged",
69 )
70 }
71
72 fn run_prettier_fix() -> Step<Run> {
73 named::bash("./script/prettier --write")
74 }
75
76 fn create_patch() -> Step<Run> {
77 named::bash(indoc::indoc! {r#"
78 if git diff --quiet; then
79 echo "No changes to commit"
80 echo "has_changes=false" >> "$GITHUB_OUTPUT"
81 else
82 git diff > autofix.patch
83 echo "has_changes=true" >> "$GITHUB_OUTPUT"
84 fi
85 "#})
86 .id("create-patch")
87 }
88
89 named::job(
90 Job::default()
91 .runs_on(runners::LINUX_DEFAULT)
92 .outputs([(
93 "has_changes".to_owned(),
94 "${{ steps.create-patch.outputs.has_changes }}".to_owned(),
95 )])
96 .add_step(steps::checkout_repo())
97 .add_step(checkout_pr(pr_number))
98 .add_step(steps::setup_cargo_config(runners::Platform::Linux))
99 .add_step(steps::cache_rust_dependencies_namespace())
100 .map(steps::install_linux_dependencies)
101 .add_step(steps::setup_pnpm())
102 .add_step(run_prettier_fix())
103 .add_step(run_cargo_fmt())
104 .add_step(run_clippy_fix().if_condition(Expression::new(run_clippy.to_string())))
105 .add_step(create_patch())
106 .add_step(upload_patch_artifact())
107 .add_step(steps::cleanup_cargo_config(runners::Platform::Linux)),
108 )
109}
110
111fn commit_changes(pr_number: &WorkflowInput, autofix_job: &NamedJob) -> NamedJob {
112 fn authenticate_as_zippy() -> (Step<Use>, StepOutput) {
113 let step = named::uses(
114 "actions",
115 "create-github-app-token",
116 "bef1eaf1c0ac2b148ee2a0a74c65fbe6db0631f1",
117 )
118 .add_with(("app-id", vars::ZED_ZIPPY_APP_ID))
119 .add_with(("private-key", vars::ZED_ZIPPY_APP_PRIVATE_KEY))
120 .id("get-app-token");
121 let output = StepOutput::new(&step, "token");
122 (step, output)
123 }
124
125 fn checkout_pr(pr_number: &WorkflowInput, token: &StepOutput) -> Step<Run> {
126 named::bash(&format!("gh pr checkout {pr_number}")).add_env(("GITHUB_TOKEN", token))
127 }
128
129 fn apply_patch() -> Step<Run> {
130 named::bash("git apply autofix.patch")
131 }
132
133 fn commit_and_push(token: &StepOutput) -> Step<Run> {
134 named::bash(indoc::indoc! {r#"
135 git commit -am "Autofix"
136 git push
137 "#})
138 .add_env(("GIT_COMMITTER_NAME", "Zed Zippy"))
139 .add_env((
140 "GIT_COMMITTER_EMAIL",
141 "234243425+zed-zippy[bot]@users.noreply.github.com",
142 ))
143 .add_env(("GIT_AUTHOR_NAME", "Zed Zippy"))
144 .add_env((
145 "GIT_AUTHOR_EMAIL",
146 "234243425+zed-zippy[bot]@users.noreply.github.com",
147 ))
148 .add_env(("GITHUB_TOKEN", token))
149 }
150
151 let (authenticate, token) = authenticate_as_zippy();
152
153 named::job(
154 Job::default()
155 .runs_on(runners::LINUX_SMALL)
156 .needs(vec![autofix_job.name.clone()])
157 .cond(Expression::new(format!(
158 "needs.{}.outputs.has_changes == 'true'",
159 autofix_job.name
160 )))
161 .add_step(authenticate)
162 .add_step(steps::checkout_repo_with_token(&token))
163 .add_step(checkout_pr(pr_number, &token))
164 .add_step(download_patch_artifact())
165 .add_step(apply_patch())
166 .add_step(commit_and_push(&token)),
167 )
168}