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