wrkflw

mirror of https://github.com/bahdotsh/wrkflw.git synced 2026-09-02 12:16:16 +02:00

Files

bahdotsh af5e80e97e docs: update crate READMEs for latest features and trim secrets

The crate READMEs were quietly falling behind the actual code. The
executor README didn't mention --job, environment file read-back,
or job-level container directives. The UI README didn't mention job
selection mode or the tui feature flag. The evaluator README didn't
mention composite action input cross-checking.

Meanwhile, the secrets README was 387 lines of documentation for a
crate whose siblings average 25. It had full provider configuration
examples, rate limiting docs, input validation specs, and
benchmarking instructions — all of which belong in rustdoc, not a
README that's supposed to give you a quick overview.

Trim secrets to ~80 lines. Update executor, ui, evaluator, and
wrkflw READMEs to reflect features from PRs #77-#83.

2026-04-02 23:57:40 +05:30

src

feat(executor): add GitHub Actions environment file read-back (#83 )

2026-04-02 23:41:36 +05:30

Cargo.toml

feat(executor): easy GHA emulation fixes for better compatibility (#82 )

2026-04-02 18:00:41 +05:30

README.md

docs: update crate READMEs for latest features and trim secrets

2026-04-02 23:57:40 +05:30

README.md

wrkflw-executor

The execution engine that runs GitHub Actions workflows locally (Docker, Podman, or emulation).

Job graph execution with needs ordering and parallel independent jobs
Docker/Podman container steps and emulation mode
Run individual jobs via target_job / --job flag
GitHub Actions environment file support (GITHUB_OUTPUT, GITHUB_ENV, GITHUB_PATH, GITHUB_STEP_SUMMARY) with read-back
Docker-based action resolution (container, JavaScript, composite, local)
Job-level container: directive support
Used by: wrkflw CLI and TUI

API sketch

use wrkflw_executor::{execute_workflow, ExecutionConfig, RuntimeType};

let cfg = ExecutionConfig {
    runtime: RuntimeType::Docker,
    verbose: true,
    preserve_containers_on_failure: false,
    target_job: Some("build".to_string()), // run a single job
};

let workflow_path = std::path::Path::new(".github/workflows/ci.yml");
let result = execute_workflow(workflow_path, cfg).await?;
println!("workflow status: {:?}", result.summary_status);

Prefer using the wrkflw binary for a complete UX across validation, execution, and logs.