feat: performance report pipeline (versioned benchmark snapshots)#90
Merged
feat: performance report pipeline (versioned benchmark snapshots)#90
Conversation
…pipeline - Enhance CI bench workflow to run on push to main and PRs, generating structured JSON snapshots with version, commit, date, toolchain, and per-benchmark timings (ns/iter + deviation) - Post human-readable Markdown benchmark report to GitHub Actions step summary for quick visibility - Add PR comparison step that surfaces current benchmark data for regression review - Upload benchmark artifacts (JSON snapshots, Criterion HTML reports, raw bencher output) with 90-day retention - Add local scripts/bench-report.sh for developers to generate the same snapshots locally with bench-latest.json symlink - Add bench-results/ directory with README documenting snapshot format, CI integration, and usage for release notes - gitignore local snapshot files, track only README Fixes #84
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
1 participant
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.
Summary
Automate benchmark snapshots and keep a historical report for release notes.
Changes
CI workflow (
.github/workflows/bench.yml): Enhanced to run on both push-to-main and PRs. Now generates structured JSON snapshots containing version, commit, date, Rust toolchain, and per-benchmark timings. Posts a human-readable Markdown report to the GitHub Actions step summary. Uploads artifacts with 90-day retention. Adds a PR comparison step for regression review.Local script (
scripts/bench-report.sh): Developers can generate the same snapshots locally, producing JSON + text reports and abench-latest.*copy for quick access.Documentation (
bench-results/README.md): Describes the snapshot format, CI integration, and how to use snapshots for release notes.Snapshot format
{ "version": "0.1.0", "date": "2026-02-23", "timestamp": "2026-02-23T22:38:00Z", "commit": "abc1234...", "rust_version": "rustc 1.82.0 ...", "benchmarks": [ {"name": "parse_json/records/1000", "ns_per_iter": 123456, "deviation": 789} ] }Tracked benchmarks
Parsing, serialization, format conversion, mapping operations, and end-to-end pipeline — each at 100 / 1,000 / 10,000 records.
Fixes #84