bench-show v0.3.1 Release Notes
Release Date: 2020-01-12 // about 5 years ago-
๐ Bug Fixes
report
andgraph
generation now works even when number of samples is less than 3
Previous changes from v0.3.0
-
๐ฅ Breaking Changes
- The signature of
selectBenchmarks
has changed, use 'Nothing' as the second argument of the benchmark generator function to port old code without any impact. - โ Removed the broken 'Percent' constructor from
GroupStyle
. UsePercentDiff
instead to make relative comparisons. - The behavior of
PercentDiff
has changed, it now computes the % from the lower value instead of from the baseline. - 0๏ธโฃ The default
diffStrategy
has been changed toSingleEstimator
instead ofMinEstimator
.
๐ Deprecations
- ๐ Config fields
title
andtitleAnnotations
have been deprecated, please usemkTitle
instead.
๐ Bug Fixes
- ๐
GroupStyle Absolute
now honors theMinEstimator
setting. WhenMinEstimator
is set, the groups being compared to baseline now display the value based on the estimator which provides closest estimate to the baseline.
โจ Enhancements
- โ Add a CLI executable to generate textual reports and graphs from criterion or gauge csv output file.
- โ Add
Multiples
as a comparison option, the group being compared is shown as a multiple of the baseline. - โ Add ability to omit the baseline group from the results when we are doing a relative comparison among groups.
- โ Add the ability to sort the benchmarks using a different criterion than the one used to present the benchmarks in the final report output.
- โ Add
mkTitle
config option to use a function for generating a custom report title.
- The signature of