feat(#247): benchmark regression CI with thresholds and docs - #354
Merged
miss-yusrah merged 1 commit intoAug 31, 2026
Merged
Conversation
…s and docs - Add ci/bench-samples.csv: checked-in baselines for all test_bench_* operations (register x2, usernames_match x4, get_all_registered x4, verify success + rejection). Tagged with soroban-sdk 26.0.1. - Add scripts/check_bench_regression.sh: parses CSV bench output from stdin, compares against baselines, fails on >15% regression or breach of hard absolute caps (25M CPU / 3M mem for register/verify). Exit codes: 0=pass, 1=regression/cap breach, 2=setup error. - Add .github/workflows/ci.yml bench-budget job: runs after quality gate, executes all four bench test functions with --test-threads=1, pipes output through check_bench_regression.sh, uploads bench-budget-report artifact with 30-day retention. - Add docs/BENCHMARK_BUDGETS.md: threshold rationale, tracked operations table, hard cap table, host-vs-release notes, baseline update workflow. - Update docs/CONTRIBUTING.md: Benchmark Budget CI section, baseline update procedure, PR checklist item. - Update Makefile: bench-budget-ci (mirrors CI job locally), bench-update-samples (regenerates ci/bench-samples.csv), .PHONY.
|
@Audukuma Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
3 participants
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 #247
Add ci/bench-samples.csv: checked-in baselines for all test_bench_* operations (register x2, usernames_match x4, get_all_registered x4, verify success + rejection). Tagged with soroban-sdk 26.0.1.
Add scripts/check_bench_regression.sh: parses CSV bench output from stdin, compares against baselines, fails on >15% regression or breach of hard absolute caps (25M CPU / 3M mem for register/verify). Exit codes: 0=pass, 1=regression/cap breach, 2=setup error.
Add .github/workflows/ci.yml bench-budget job: runs after quality gate, executes all four bench test functions with --test-threads=1, pipes output through check_bench_regression.sh, uploads bench-budget-report artifact with 30-day retention.
Add docs/BENCHMARK_BUDGETS.md: threshold rationale, tracked operations table, hard cap table, host-vs-release notes, baseline update workflow.
Update docs/CONTRIBUTING.md: Benchmark Budget CI section, baseline update procedure, PR checklist item.
Update Makefile: bench-budget-ci (mirrors CI job locally), bench-update-samples (regenerates ci/bench-samples.csv), .PHONY.