1use gh_workflow::*;
2
3use crate::tasks::workflows::{runners::Platform, vars};
4
5const BASH_SHELL: &str = "bash -euxo pipefail {0}";
6// https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idstepsshell
7const PWSH_SHELL: &str = "pwsh";
8
9pub fn checkout_repo() -> Step<Use> {
10 named::uses(
11 "actions",
12 "checkout",
13 "11bd71901bbe5b1630ceea73d27597364c9af683", // v4
14 )
15 // prevent checkout action from running `git clean -ffdx` which
16 // would delete the target directory
17 .add_with(("clean", false))
18}
19
20pub fn setup_pnpm() -> Step<Use> {
21 named::uses(
22 "pnpm",
23 "action-setup",
24 "fe02b34f77f8bc703788d5817da081398fad5dd2", // v4.0.0
25 )
26 .add_with(("version", "9"))
27}
28
29pub fn setup_node() -> Step<Use> {
30 named::uses(
31 "actions",
32 "setup-node",
33 "49933ea5288caeca8642d1e84afbd3f7d6820020", // v4
34 )
35 .add_with(("node-version", "20"))
36}
37
38pub fn setup_sentry() -> Step<Use> {
39 named::uses(
40 "matbour",
41 "setup-sentry-cli",
42 "3e938c54b3018bdd019973689ef984e033b0454b",
43 )
44 .add_with(("token", vars::SENTRY_AUTH_TOKEN))
45}
46
47pub fn cargo_fmt() -> Step<Run> {
48 named::bash("cargo fmt --all -- --check")
49}
50
51pub fn cargo_install_nextest(platform: Platform) -> Step<Run> {
52 named::run(platform, "cargo install cargo-nextest --locked")
53}
54
55pub fn cargo_nextest(platform: Platform) -> Step<Run> {
56 named::run(
57 platform,
58 "cargo nextest run --workspace --no-fail-fast --failure-output immediate-final",
59 )
60}
61
62pub fn setup_cargo_config(platform: Platform) -> Step<Run> {
63 match platform {
64 Platform::Windows => named::pwsh(indoc::indoc! {r#"
65 New-Item -ItemType Directory -Path "./../.cargo" -Force
66 Copy-Item -Path "./.cargo/ci-config.toml" -Destination "./../.cargo/config.toml"
67 "#}),
68
69 Platform::Linux | Platform::Mac => named::bash(indoc::indoc! {r#"
70 mkdir -p ./../.cargo
71 cp ./.cargo/ci-config.toml ./../.cargo/config.toml
72 "#}),
73 }
74}
75
76pub fn cleanup_cargo_config(platform: Platform) -> Step<Run> {
77 let step = match platform {
78 Platform::Windows => named::pwsh(indoc::indoc! {r#"
79 Remove-Item -Recurse -Path "./../.cargo" -Force -ErrorAction SilentlyContinue
80 "#}),
81 Platform::Linux | Platform::Mac => named::bash(indoc::indoc! {r#"
82 rm -rf ./../.cargo
83 "#}),
84 };
85
86 step.if_condition(Expression::new("always()"))
87}
88
89pub fn upload_artifact(name: &str, path: &str) -> Step<Use> {
90 Step::new(format!("@actions/upload-artifact {}", name))
91 .uses(
92 "actions",
93 "upload-artifact",
94 "330a01c490aca151604b8cf639adc76d48f6c5d4", // v5
95 )
96 .add_with(("name", name))
97 .add_with(("path", path))
98}
99
100pub fn clear_target_dir_if_large(platform: Platform) -> Step<Run> {
101 match platform {
102 Platform::Windows => named::pwsh("./script/clear-target-dir-if-larger-than.ps1 250"),
103 Platform::Linux => named::bash("./script/clear-target-dir-if-larger-than 100"),
104 Platform::Mac => named::bash("./script/clear-target-dir-if-larger-than 300"),
105 }
106}
107
108pub(crate) fn clippy(platform: Platform) -> Step<Run> {
109 match platform {
110 Platform::Windows => named::pwsh("./script/clippy.ps1"),
111 _ => named::bash("./script/clippy"),
112 }
113}
114
115pub(crate) fn cache_rust_dependencies() -> Step<Use> {
116 named::uses(
117 "swatinem",
118 "rust-cache",
119 "9d47c6ad4b02e050fd481d890b2ea34778fd09d6", // v2
120 )
121 .with(("save-if", "${{ github.ref == 'refs/heads/main' }}"))
122}
123
124fn setup_linux() -> Step<Run> {
125 named::bash("./script/linux")
126}
127
128fn install_mold() -> Step<Run> {
129 named::bash("./script/install-mold")
130}
131
132pub(crate) fn install_linux_dependencies(job: Job) -> Job {
133 job.add_step(setup_linux()).add_step(install_mold())
134}
135
136pub fn script(name: &str) -> Step<Run> {
137 if name.ends_with(".ps1") {
138 Step::new(name).run(name).shell(PWSH_SHELL)
139 } else {
140 Step::new(name).run(name).shell(BASH_SHELL)
141 }
142}
143
144pub(crate) struct NamedJob {
145 pub name: String,
146 pub job: Job,
147}
148
149pub(crate) fn release_job(deps: &[&NamedJob]) -> Job {
150 let job = Job::default()
151 .cond(Expression::new(
152 "github.repository_owner == 'zed-industries'",
153 ))
154 .timeout_minutes(60u32);
155 if deps.len() > 0 {
156 job.needs(deps.iter().map(|j| j.name.clone()).collect::<Vec<_>>())
157 } else {
158 job
159 }
160}
161
162impl FluentBuilder for Job {}
163impl FluentBuilder for Workflow {}
164
165/// A helper trait for building complex objects with imperative conditionals in a fluent style.
166/// Copied from GPUI to avoid adding GPUI as dependency
167/// todo(ci) just put this in gh-workflow
168#[allow(unused)]
169pub(crate) trait FluentBuilder {
170 /// Imperatively modify self with the given closure.
171 fn map<U>(self, f: impl FnOnce(Self) -> U) -> U
172 where
173 Self: Sized,
174 {
175 f(self)
176 }
177
178 /// Conditionally modify self with the given closure.
179 fn when(self, condition: bool, then: impl FnOnce(Self) -> Self) -> Self
180 where
181 Self: Sized,
182 {
183 self.map(|this| if condition { then(this) } else { this })
184 }
185
186 /// Conditionally modify self with the given closure.
187 fn when_else(
188 self,
189 condition: bool,
190 then: impl FnOnce(Self) -> Self,
191 else_fn: impl FnOnce(Self) -> Self,
192 ) -> Self
193 where
194 Self: Sized,
195 {
196 self.map(|this| if condition { then(this) } else { else_fn(this) })
197 }
198
199 /// Conditionally unwrap and modify self with the given closure, if the given option is Some.
200 fn when_some<T>(self, option: Option<T>, then: impl FnOnce(Self, T) -> Self) -> Self
201 where
202 Self: Sized,
203 {
204 self.map(|this| {
205 if let Some(value) = option {
206 then(this, value)
207 } else {
208 this
209 }
210 })
211 }
212 /// Conditionally unwrap and modify self with the given closure, if the given option is None.
213 fn when_none<T>(self, option: &Option<T>, then: impl FnOnce(Self) -> Self) -> Self
214 where
215 Self: Sized,
216 {
217 self.map(|this| if option.is_some() { this } else { then(this) })
218 }
219}
220
221// (janky) helper to generate steps with a name that corresponds
222// to the name of the calling function.
223pub(crate) mod named {
224 use super::*;
225
226 /// Returns a uses step with the same name as the enclosing function.
227 /// (You shouldn't inline this function into the workflow definition, you must
228 /// wrap it in a new function.)
229 pub(crate) fn uses(owner: &str, repo: &str, ref_: &str) -> Step<Use> {
230 Step::new(function_name(1)).uses(owner, repo, ref_)
231 }
232
233 /// Returns a bash-script step with the same name as the enclosing function.
234 /// (You shouldn't inline this function into the workflow definition, you must
235 /// wrap it in a new function.)
236 pub(crate) fn bash(script: &str) -> Step<Run> {
237 Step::new(function_name(1)).run(script).shell(BASH_SHELL)
238 }
239
240 /// Returns a pwsh-script step with the same name as the enclosing function.
241 /// (You shouldn't inline this function into the workflow definition, you must
242 /// wrap it in a new function.)
243 pub(crate) fn pwsh(script: &str) -> Step<Run> {
244 Step::new(function_name(1)).run(script).shell(PWSH_SHELL)
245 }
246
247 /// Runs the command in either powershell or bash, depending on platform.
248 /// (You shouldn't inline this function into the workflow definition, you must
249 /// wrap it in a new function.)
250 pub(crate) fn run(platform: Platform, script: &str) -> Step<Run> {
251 match platform {
252 Platform::Windows => Step::new(function_name(1)).run(script).shell(PWSH_SHELL),
253 Platform::Linux | Platform::Mac => {
254 Step::new(function_name(1)).run(script).shell(BASH_SHELL)
255 }
256 }
257 }
258
259 /// Returns a Workflow with the same name as the enclosing module.
260 pub(crate) fn workflow() -> Workflow {
261 Workflow::default().name(
262 named::function_name(1)
263 .split("::")
264 .next()
265 .unwrap()
266 .to_owned(),
267 )
268 }
269
270 /// Returns a Job with the same name as the enclosing function.
271 /// (note job names may not contain `::`)
272 pub(crate) fn job(job: Job) -> NamedJob {
273 NamedJob {
274 name: function_name(1).split("::").last().unwrap().to_owned(),
275 job,
276 }
277 }
278
279 /// Returns the function name N callers above in the stack
280 /// (typically 1).
281 /// This only works because xtask always runs debug builds.
282 pub(crate) fn function_name(i: usize) -> String {
283 let mut name = "<unknown>".to_string();
284 let mut count = 0;
285 backtrace::trace(|frame| {
286 if count < i + 3 {
287 count += 1;
288 return true;
289 }
290 backtrace::resolve_frame(frame, |cb| {
291 if let Some(s) = cb.name() {
292 name = s.to_string()
293 }
294 });
295 false
296 });
297 name.split("::")
298 .skip_while(|s| s != &"workflows")
299 .skip(1)
300 .collect::<Vec<_>>()
301 .join("::")
302 }
303}