bench-show v0.3.1 Release Notes

Release Date: 2020-01-12 // almost 2 years ago
  • 🐛 Bug Fixes

    • report and graph 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. Use PercentDiff 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 to SingleEstimator instead of MinEstimator.

    🗄 Deprecations

    • 🗄 Config fields title and titleAnnotations have been deprecated, please use mkTitle instead.

    🐛 Bug Fixes

    • 💅 GroupStyle Absolute now honors the MinEstimator setting. When MinEstimator 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.