docs: add README for workspace and all 7 crates

Root README covers architecture, Rust builder API quick start,
YAML pipeline quick start, provider table, deno executor overview,
feature flags, and testing instructions.

Per-crate READMEs follow consistent structure: one-liner, what it
does, quick start code example, API reference, configuration,
testing, license. Engineering-confident tone throughout.
This commit is contained in:
2026-03-26 00:25:23 +00:00
parent 7497d4c80b
commit 386cd2255d
8 changed files with 865 additions and 0 deletions

118
wfe-yaml/README.md Normal file
View File

@@ -0,0 +1,118 @@
# 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:
```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:
```rust
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`:
```rust
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
```sh
# 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