1use gh_workflow::*;
2
3use crate::tasks::workflows::{runners::Platform, vars};
4
5pub const BASH_SHELL: &str = "bash -euxo pipefail {0}";
6// https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idstepsshell
7pub const 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_namespace() -> Step<Use> {
116 let allowlisted_binaries: &str = &[
117 "/home/runner/.cargo/bin/cargo-nextest",
118 "/home/runner/.cargo/bin/cargo-about",
119 ]
120 .join("\n");
121 named::uses("namespacelabs", "nscloud-cache-action", "v1")
122 .add_with(("cache", "rust"))
123 .add_with(("path", allowlisted_binaries))
124}
125
126fn setup_linux() -> Step<Run> {
127 named::bash("./script/linux")
128}
129
130fn install_mold() -> Step<Run> {
131 named::bash("./script/install-mold")
132}
133
134pub(crate) fn install_linux_dependencies(job: Job) -> Job {
135 job.add_step(setup_linux()).add_step(install_mold())
136}
137
138pub fn script(name: &str) -> Step<Run> {
139 if name.ends_with(".ps1") {
140 Step::new(name).run(name).shell(PWSH_SHELL)
141 } else {
142 Step::new(name).run(name).shell(BASH_SHELL)
143 }
144}
145
146pub(crate) struct NamedJob {
147 pub name: String,
148 pub job: Job,
149}
150
151// impl NamedJob {
152// pub fn map(self, f: impl FnOnce(Job) -> Job) -> Self {
153// NamedJob {
154// name: self.name,
155// job: f(self.job),
156// }
157// }
158// }
159
160pub(crate) fn release_job(deps: &[&NamedJob]) -> Job {
161 let job = Job::default()
162 .cond(Expression::new(
163 "github.repository_owner == 'zed-industries'",
164 ))
165 .timeout_minutes(60u32);
166 if deps.len() > 0 {
167 job.needs(deps.iter().map(|j| j.name.clone()).collect::<Vec<_>>())
168 } else {
169 job
170 }
171}
172
173impl FluentBuilder for Job {}
174impl FluentBuilder for Workflow {}
175
176/// A helper trait for building complex objects with imperative conditionals in a fluent style.
177/// Copied from GPUI to avoid adding GPUI as dependency
178/// todo(ci) just put this in gh-workflow
179#[allow(unused)]
180pub(crate) trait FluentBuilder {
181 /// Imperatively modify self with the given closure.
182 fn map<U>(self, f: impl FnOnce(Self) -> U) -> U
183 where
184 Self: Sized,
185 {
186 f(self)
187 }
188
189 /// Conditionally modify self with the given closure.
190 fn when(self, condition: bool, then: impl FnOnce(Self) -> Self) -> Self
191 where
192 Self: Sized,
193 {
194 self.map(|this| if condition { then(this) } else { this })
195 }
196
197 /// Conditionally modify self with the given closure.
198 fn when_else(
199 self,
200 condition: bool,
201 then: impl FnOnce(Self) -> Self,
202 else_fn: impl FnOnce(Self) -> Self,
203 ) -> Self
204 where
205 Self: Sized,
206 {
207 self.map(|this| if condition { then(this) } else { else_fn(this) })
208 }
209
210 /// Conditionally unwrap and modify self with the given closure, if the given option is Some.
211 fn when_some<T>(self, option: Option<T>, then: impl FnOnce(Self, T) -> Self) -> Self
212 where
213 Self: Sized,
214 {
215 self.map(|this| {
216 if let Some(value) = option {
217 then(this, value)
218 } else {
219 this
220 }
221 })
222 }
223 /// Conditionally unwrap and modify self with the given closure, if the given option is None.
224 fn when_none<T>(self, option: &Option<T>, then: impl FnOnce(Self) -> Self) -> Self
225 where
226 Self: Sized,
227 {
228 self.map(|this| if option.is_some() { this } else { then(this) })
229 }
230}
231
232// (janky) helper to generate steps with a name that corresponds
233// to the name of the calling function.
234pub(crate) mod named {
235 use super::*;
236
237 /// Returns a uses step with the same name as the enclosing function.
238 /// (You shouldn't inline this function into the workflow definition, you must
239 /// wrap it in a new function.)
240 pub(crate) fn uses(owner: &str, repo: &str, ref_: &str) -> Step<Use> {
241 Step::new(function_name(1)).uses(owner, repo, ref_)
242 }
243
244 /// Returns a bash-script step with the same name as the enclosing function.
245 /// (You shouldn't inline this function into the workflow definition, you must
246 /// wrap it in a new function.)
247 pub(crate) fn bash(script: &str) -> Step<Run> {
248 Step::new(function_name(1)).run(script).shell(BASH_SHELL)
249 }
250
251 /// Returns a pwsh-script step with the same name as the enclosing function.
252 /// (You shouldn't inline this function into the workflow definition, you must
253 /// wrap it in a new function.)
254 pub(crate) fn pwsh(script: &str) -> Step<Run> {
255 Step::new(function_name(1)).run(script).shell(PWSH_SHELL)
256 }
257
258 /// Runs the command in either powershell or bash, depending on platform.
259 /// (You shouldn't inline this function into the workflow definition, you must
260 /// wrap it in a new function.)
261 pub(crate) fn run(platform: Platform, script: &str) -> Step<Run> {
262 match platform {
263 Platform::Windows => Step::new(function_name(1)).run(script).shell(PWSH_SHELL),
264 Platform::Linux | Platform::Mac => {
265 Step::new(function_name(1)).run(script).shell(BASH_SHELL)
266 }
267 }
268 }
269
270 /// Returns a Workflow with the same name as the enclosing module.
271 pub(crate) fn workflow() -> Workflow {
272 Workflow::default().name(
273 named::function_name(1)
274 .split("::")
275 .next()
276 .unwrap()
277 .to_owned(),
278 )
279 }
280
281 /// Returns a Job with the same name as the enclosing function.
282 /// (note job names may not contain `::`)
283 pub(crate) fn job(job: Job) -> NamedJob {
284 NamedJob {
285 name: function_name(1).split("::").last().unwrap().to_owned(),
286 job,
287 }
288 }
289
290 /// Returns the function name N callers above in the stack
291 /// (typically 1).
292 /// This only works because xtask always runs debug builds.
293 pub(crate) fn function_name(i: usize) -> String {
294 let mut name = "<unknown>".to_string();
295 let mut count = 0;
296 backtrace::trace(|frame| {
297 if count < i + 3 {
298 count += 1;
299 return true;
300 }
301 backtrace::resolve_frame(frame, |cb| {
302 if let Some(s) = cb.name() {
303 name = s.to_string()
304 }
305 });
306 false
307 });
308 name.split("::")
309 .skip_while(|s| s != &"workflows")
310 .skip(1)
311 .collect::<Vec<_>>()
312 .join("::")
313 }
314}