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