docs: describe the Fixtures-based full-benchmark flow accurately#147
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #130. Closes #131.
The action generates fixtures via the
FerrLabs/Fixturesaction from a JSONdefinitionsdirectory, but the docs still described the old local-binary flow and mislabelled the input format:action.ymldefinitionsinput said "Path to TOML definitions"; the generator only reads JSON (and the value is passed straight toFerrLabs/Fixtures, whose input is JSON). Now: "Path to the directory of JSON fixture definitions…", matching Fixtures.fullsection + Requirements claimed fixtures come fromcargo run --release --bin generate-fixtures(a binary the action never invokes). Rewritten to the real flow: fixtures come fromFerrLabs/Fixtures(caller supplies thedefinitionsdir), and the project must build a release binary (cargo build --release) which the action puts on PATH. Dropped thegenerate-fixturesrequirement.