Our open-source projects, here for you!

Portugal

wfe-yaml (1.4.0)

Published 2026-03-27 00:33:46 +00:00 by siennathesane

Set up this registry in the Cargo configuration file (for example ~/.cargo/config.toml):

[registry]
default = "gitea"

[registries.gitea]
index = "sparse+" # Sparse index
# index = "" # Git

[net]
git-fetch-with-cli = true

To install the package using Cargo, run the following command:

cargo add wfe-yaml@1.4.0

For more information on the Cargo registry, see the documentation.

YAML workflow definitions for WFE

wfe-yaml

YAML workflow definitions for WFE.

What it does

wfe-yaml lets you define workflows in YAML instead of Rust code. It parses YAML files, validates the schema, interpolates variables, compiles the result into WorkflowDefinition + step factories, and hands them to the WFE host. Ships with a shell executor and an optional sandboxed Deno executor for running JavaScript/TypeScript steps.

Quick start

Define a workflow in YAML:

workflow:
  id: deploy
  version: 1
  steps:
    - name: build
      type: shell
      config:
        run: cargo build --release
        timeout: 5m

    - name: test
      type: shell
      config:
        run: cargo test
        env:
          RUST_LOG: info

    - name: notify
      type: deno
      config:
        script: |
          const result = Wfe.getData("build.stdout");
          Wfe.setOutput("status", "deployed");
        permissions:
          net: ["https://hooks.slack.com"]

Load and register it:

use std::collections::HashMap;
use std::path::Path;

let config = HashMap::new();
let compiled = wfe_yaml::load_workflow(Path::new("deploy.yaml"), &config)?;

// Register with the host.
host.register_workflow_definition(compiled.definition).await;
for (key, factory) in compiled.step_factories {
    host.register_step_factory(&key, factory).await;
}

Variable interpolation

Use ${{ var.name }} syntax in YAML. Variables are resolved from the config map passed to load_workflow:

let mut config = HashMap::new();
config.insert("env".into(), serde_json::json!("production"));

let compiled = wfe_yaml::load_workflow_from_str(&yaml_str, &config)?;

API

Type	Description
`load_workflow()`	Load from a file path with variable interpolation.
`load_workflow_from_str()`	Load from a YAML string with variable interpolation.
`CompiledWorkflow`	Contains a `WorkflowDefinition` and a `Vec<(String, StepFactory)>` ready for host registration.
`YamlWorkflow`	Top-level YAML schema (`workflow:` key).
`WorkflowSpec`	Workflow definition: id, version, description, error behavior, steps.
`YamlStep`	Step definition: name, type, config, inputs/outputs, parallel children, error handling hooks (`on_success`, `on_failure`, `ensure`).
`ShellStep`	Executes shell commands via `tokio::process::Command`. Captures stdout/stderr, parses `##wfe[output name=value]` directives.
`DenoStep`	Executes JS/TS in an embedded Deno runtime with configurable permissions.

Shell step features

Configurable shell (defaults to sh)
Workflow data injected as UPPER_CASE environment variables
Custom env vars via config.env
Working directory override
Timeout support
Structured output via ##wfe[output name=value] lines in stdout

Deno step features

Inline script or external file source
Automatic module evaluation for import/export/await syntax
Granular permissions: net, read, write, env, run, dynamic_import
Wfe.getData() / Wfe.setOutput() host bindings
V8-level timeout enforcement (catches infinite loops)

Features

Feature	Description
`deno`	Enables the Deno JavaScript/TypeScript executor. Pulls in `deno_core`, `deno_error`, `url`, `reqwest`. Off by default.

Testing

# Core tests (shell executor)
cargo test -p wfe-yaml

# With Deno executor
cargo test -p wfe-yaml --features deno

No external services required. Deno tests need the deno feature flag.

License

MIT

ID	Version
async-trait	^0.1
deno_core	^0.394
deno_error	^0.7
regex	^1
reqwest	^0.12
serde	^1
serde_json	^1
serde_yaml	^0.9
thiserror	^2
tokio	^1
tracing	^0.1
url	^2
wfe-buildkit	^1.4.0
wfe-containerd	^1.4.0
wfe-core	^1.4.0
yaml-merge-keys	^0.8
pretty_assertions	^1
tempfile	^3
tokio	^1
tokio-util	^0.7
wfe-core	^1.4.0
wiremock	^0.6

Details

Cargo

2026-03-27 00:33:46 +00:00

68 KiB

Assets (1)

wfe-yaml-1.4.0.crate 68 KiB

Versions (2) View all

1.4.0

2026-03-27

1.0.0

2026-03-26