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 install_cargo_machete() -> Step<Use> {
63 named::uses(
64 "clechasseur",
65 "rs-cargo",
66 "8435b10f6e71c2e3d4d3b7573003a8ce4bfc6386", // v2
67 )
68 .add_with(("command", "install"))
69 .add_with(("args", "cargo-machete@0.7.0"))
70 }
71
72 fn run_cargo_fmt() -> Step<Run> {
73 named::bash("cargo fmt --all")
74 }
75
76 fn run_cargo_fix() -> Step<Run> {
77 named::bash(
78 "cargo fix --workspace --release --all-targets --all-features --allow-dirty --allow-staged",
79 )
80 }
81
82 fn run_cargo_machete_fix() -> Step<Run> {
83 named::bash("cargo machete --fix")
84 }
85
86 fn run_clippy_fix() -> Step<Run> {
87 named::bash(
88 "cargo clippy --workspace --release --all-targets --all-features --fix --allow-dirty --allow-staged",
89 )
90 }
91
92 fn run_prettier_fix() -> Step<Run> {
93 named::bash("./script/prettier --write")
94 }
95
96 fn create_patch() -> Step<Run> {
97 named::bash(indoc::indoc! {r#"
98 if git diff --quiet; then
99 echo "No changes to commit"
100 echo "has_changes=false" >> "$GITHUB_OUTPUT"
101 else
102 git diff > autofix.patch
103 echo "has_changes=true" >> "$GITHUB_OUTPUT"
104 fi
105 "#})
106 .id("create-patch")
107 }
108
109 named::job(
110 Job::default()
111 .runs_on(runners::LINUX_DEFAULT)
112 .outputs([(
113 "has_changes".to_owned(),
114 "${{ steps.create-patch.outputs.has_changes }}".to_owned(),
115 )])
116 .add_step(steps::checkout_repo())
117 .add_step(checkout_pr(pr_number))
118 .add_step(steps::setup_cargo_config(runners::Platform::Linux))
119 .add_step(steps::cache_rust_dependencies_namespace())
120 .map(steps::install_linux_dependencies)
121 .add_step(steps::setup_pnpm())
122 .add_step(run_prettier_fix())
123 .add_step(run_cargo_fmt())
124 .add_step(install_cargo_machete().if_condition(Expression::new(run_clippy.to_string())))
125 .add_step(run_cargo_fix().if_condition(Expression::new(run_clippy.to_string())))
126 .add_step(run_cargo_machete_fix().if_condition(Expression::new(run_clippy.to_string())))
127 .add_step(run_clippy_fix().if_condition(Expression::new(run_clippy.to_string())))
128 .add_step(create_patch())
129 .add_step(upload_patch_artifact())
130 .add_step(steps::cleanup_cargo_config(runners::Platform::Linux)),
131 )
132}
133
134fn commit_changes(pr_number: &WorkflowInput, autofix_job: &NamedJob) -> NamedJob {
135 fn checkout_pr(pr_number: &WorkflowInput, token: &StepOutput) -> Step<Run> {
136 named::bash(&format!("gh pr checkout {pr_number}")).add_env(("GITHUB_TOKEN", token))
137 }
138
139 fn apply_patch() -> Step<Run> {
140 named::bash("git apply autofix.patch")
141 }
142
143 fn commit_and_push(token: &StepOutput) -> Step<Run> {
144 named::bash(indoc::indoc! {r#"
145 git commit -am "Autofix"
146 git push
147 "#})
148 .add_env(("GIT_COMMITTER_NAME", "Zed Zippy"))
149 .add_env((
150 "GIT_COMMITTER_EMAIL",
151 "234243425+zed-zippy[bot]@users.noreply.github.com",
152 ))
153 .add_env(("GIT_AUTHOR_NAME", "Zed Zippy"))
154 .add_env((
155 "GIT_AUTHOR_EMAIL",
156 "234243425+zed-zippy[bot]@users.noreply.github.com",
157 ))
158 .add_env(("GITHUB_TOKEN", token))
159 }
160
161 let (authenticate, token) = steps::authenticate_as_zippy();
162
163 named::job(
164 Job::default()
165 .runs_on(runners::LINUX_SMALL)
166 .needs(vec![autofix_job.name.clone()])
167 .cond(Expression::new(format!(
168 "needs.{}.outputs.has_changes == 'true'",
169 autofix_job.name
170 )))
171 .add_step(authenticate)
172 .add_step(steps::checkout_repo_with_token(&token))
173 .add_step(checkout_pr(pr_number, &token))
174 .add_step(download_patch_artifact())
175 .add_step(apply_patch())
176 .add_step(commit_and_push(&token)),
177 )
178}