From 347a3413b44c79b3cb15accc1ee7a522b66e4ac5 Mon Sep 17 00:00:00 2001 From: BryanFRD Date: Wed, 17 Jun 2026 19:39:27 +0200 Subject: [PATCH] docs: describe the Fixtures-based full-benchmark flow accurately --- README.md | 5 +++-- action.yml | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e799e02..1fe0b0a 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ Runs criterion benchmarks (`cargo bench`) and compares against a stored baseline Runs end-to-end benchmarks with [hyperfine](https://github.com/sharkdp/hyperfine) across multiple fixture sizes (single repo, mono-small, mono-medium, mono-large). Optionally compares against competitor tools (semantic-release, changesets, release-please). -- Generates fixtures using `cargo run --release --bin generate-fixtures` +- Generates fixtures via the [`FerrLabs/Fixtures`](https://github.com/FerrLabs/Fixtures) action from the JSON `definitions` directory you pass - Measures execution time, memory usage, and binary size - Compares against stored baseline and detects regressions (configurable threshold, default 25%) @@ -62,4 +62,5 @@ The calling workflow must provide: - Rust cache (`Swatinem/rust-cache@v2`) - Node.js (for full benchmarks with competitors): `actions/setup-node@v6` - A project with `cargo bench --bench ferrflow_benchmarks` (for micro) -- A project with `cargo run --release --bin generate-fixtures` (for full) +- A directory of JSON fixture definitions, passed via the `definitions` input — the action generates the fixtures with [`FerrLabs/Fixtures`](https://github.com/FerrLabs/Fixtures) (for full) +- A project that builds a release binary with `cargo build --release` — the action puts `target/release` on `PATH` and benchmarks it (for full) diff --git a/action.yml b/action.yml index 0bf34ac..59eb606 100644 --- a/action.yml +++ b/action.yml @@ -44,7 +44,7 @@ inputs: required: false default: '10' definitions: - description: 'Path to TOML definitions for benchmark fixture generation' + description: 'Path to the directory of JSON fixture definitions for benchmark fixture generation' required: true verbose: description: 'Show full error output when a benchmark command fails validation'