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