Struct CiWorkflow 

pub struct CiWorkflow { /* private fields */ }

A workflow under construction. See the module docs for the shape.

Implementations

impl CiWorkflow

pub fn engine(self, engine: impl Into<String>) -> Self

Override the engine (nixery by default).

pub fn on_push<I, S>(self, branches: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add a push trigger for the given branches.

pub fn on_pull_request<I, S>(self, branches: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add a pull_request trigger targeting the given branches.

pub fn deps<I, S>(self, packages: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add nixpkgs dependencies — the toolchain the steps run against.

pub fn deps_from<I, S>(self, registry: impl Into<String>, packages: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add dependencies from a custom registry (a flake reference).

pub fn env(self, key: impl Into<String>, value: impl Into<String>) -> Self

Set a workflow-level environment variable.

pub fn step(self, name: impl Into<String>, command: impl Into<String>) -> Self

Append a step. Steps run serially, in one VM, from the workspace root.

pub fn step_env( self, name: impl Into<String>, command: impl Into<String>, env: impl IntoIterator<Item = (String, String)>, ) -> Self

Append a step with step-scoped environment variables.

pub fn clone_depth(self, depth: u32) -> Self

Set the clone depth (default 1).

pub fn skip_clone(self) -> Self

Skip the checkout entirely.

pub fn file_name(&self) -> String

The file name CiWorkflow::save writes: <name>.yml.

pub fn yaml(&self) -> String

Render the workflow file.

Scalars are emitted as JSON strings — valid YAML by construction — and commands as literal blocks when safe, so the SDK needs no YAML dependency.

pub fn save(&self, repo: impl AsRef<Path>) -> Result<PathBuf>

Write the workflow into <repo>/.tangled/workflows/, where spindle and bsdkrun ci both discover it. Returns the path.

pub fn run(&self) -> Result<()>

Execute the workflow in a microVM against the current directory, streaming output. The YAML never touches the repository — it goes to a temp file and bsdkrun ci run -f.

pub fn run_in<P: AsRef<Path>>(&self, dir: Option<P>) -> Result<()>

CiWorkflow::run against an explicit repository directory.

Trait Implementations

impl Clone for CiWorkflow

fn clone(&self) -> CiWorkflow

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CiWorkflow

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.