Release notes
*Sourced from [benchee's releases](https://github.com/PragTob/benchee/releases).*
> ## 1.0.1
> ### Bugfixes (User Facing)
> * When memory measurements were actually different extended statistics was displayed although the option was not provided. Now correctly only displayed if the option is provided and values actually had variance.
>
> ## 1.0.0
> It's 0.99.0 without the deprecation warnings. Specifically:
>
> * Old way of passing formatters (`:formatter_options`) vs. new `:formatters` with modules, tuples or functions with one arg
> * The configuration needs to be passed as the second argument to `Benchee.run/2`
> * `Benchee.collect/1` replaces `Benchee.measure/1`
> * `unit_scaling` is a top level configuration option, not for the console formatter
> * the warning for memory measurements not working on OTP <= 18 will also be dropped (we already officially dropped OTP 18 support in 0.14.0)
>
> We're aiming to follow Semantic Versioning as we go forward. That means formatters should be safe to use `~> 1.0` (or even `>= 0.99.0 and < 2.0.0`).
>
> ## 0.99.0
> The "we're almost 1.0!" release - all the last small features, a bag of polish and deprecation warnings. If you run this release succesfully without deprecation warnings you should be safe to upgrade to 1.0.0, if not - it's a bug :)
>
> ### Breaking Changes (User Facing)
> * changed official Elixir compatibility to `~> 1.6`, 1.4+ should still work but aren't guaranteed or tested against.
>
> ### Features (User Facing)
> * the console comparison now also displays the absolute difference in the average (like +12 ms) so that you have an idea to how much time that translates to in your applications not just that it's 100x faster
> * Overhaul of README, documentation, update samples etc. - a whole lot of things have also been marked `[@doc](https://github.com/doc) false` as they're considered internal
>
> ### Bugfixes (User Facing)
> * Remove double empty line after configuration display
> * Fix some wrong type specs
>
> ### Breaking Changes (Plugins)
> * `Scenario` made it to the big leagues, it's no longer `Benchee.Benchmark.Scenario` but `Benchee.Scenario` - as it is arguably one of our most important data structures.
> * The `Scenario` struct had some keys changed (last time before 2.0 I promise!) - instead of `:run_times`/`:run_time_statistics` you now have one `run_time_data` key that contains `Benchee.CollectionData` which has the keys `:samples` and `:statistics`. Same for `memory_usage`. This was done to be able to handle different kinds of measurements more uniformly as we will add more of them.
>
> ### Features (Plugins)
> * `Benchee.Statistics` comes with 3 new values: `:relative_more`, `:relative_less`, `:absolute_difference` so that you don't have to calculate these relative values yourself :)
Changelog
*Sourced from [benchee's changelog](https://github.com/bencheeorg/benchee/blob/master/CHANGELOG.md).*
> ## 1.0.1 (2019-04-09)
>
> ### Bugfixes (User Facing)
> * When memory measurements were actually different extended statistics was displayed although the option was not provided. Now correctly only displayed if the option is provided and values actually had variance.
>
> ## 1.0.0 (2019-03-28)
>
> It's 0.99.0 without the deprecation warnings. Specifically:
>
> * Old way of passing formatters (`:formatter_options`) vs. new `:formatters` with modules, tuples or functions with one arg
> * The configuration needs to be passed as the second argument to `Benchee.run/2`
> * `Benchee.collect/1` replaces `Benchee.measure/1`
> * `unit_scaling` is a top level configuration option, not for the console formatter
> * the warning for memory measurements not working on OTP <= 18 will also be dropped (we already officially dropped OTP 18 support in 0.14.0)
>
> We're aiming to follow Semantic Versioning as we go forward. That means formatters should be safe to use `~> 1.0` (or even `>= 0.99.0 and < 2.0.0`).
>
> ## 0.99.0 (2019-03-28)
>
> The "we're almost 1.0!" release - all the last small features, a bag of polish and deprecation warnings. If you run this release succesfully without deprecation warnings you should be safe to upgrade to 1.0.0, if not - it's a bug :)
>
> ### Breaking Changes (User Facing)
> * changed official Elixir compatibility to `~> 1.6`, 1.4+ should still work but aren't guaranteed or tested against.
>
> ### Features (User Facing)
> * the console comparison now also displays the absolute difference in the average (like +12 ms) so that you have an idea to how much time that translates to in your applications not just that it's 100x faster
> * Overhaul of README, documentation, update samples etc. - a whole lot of things have also been marked `[@doc](https://github.com/doc) false` as they're considered internal
>
> ### Bugfixes (User Facing)
> * Remove double empty line after configuration display
> * Fix some wrong type specs
>
> ### Breaking Changes (Plugins)
> * `Scenario` made it to the big leagues, it's no longer `Benchee.Benchmark.Scenario` but `Benchee.Scenario` - as it is arguably one of our most important data structures.
> * The `Scenario` struct had some keys changed (last time before 2.0 I promise!) - instead of `:run_times`/`:run_time_statistics` you now have one `run_time_data` key that contains `Benchee.CollectionData` which has the keys `:samples` and `:statistics`. Same for `memory_usage`. This was done to be able to handle different kinds of measurements more uniformly as we will add more of them.
>
> ### Features (Plugins)
> * `Benchee.Statistics` comes with 3 new values: `:relative_more`, `:relative_less`, `:absolute_difference` so that you don't have to calculate these relative values yourself :)
Commits
- [`87129ba`](https://github.com/bencheeorg/benchee/commit/87129baa2310524a371105a4f211cac3d4dc122c) prepare for a release of the bugfix
- [`51d2a22`](https://github.com/bencheeorg/benchee/commit/51d2a22fe25cf2fa3cefdc378590128367c38994) Sample where memory consumption is actually changing
- [`72cd7bc`](https://github.com/bencheeorg/benchee/commit/72cd7bc60bdb8983961c4475ab2749cbdb4bd27a) Only show extended memory statistics when requested
- [`408ca94`](https://github.com/bencheeorg/benchee/commit/408ca94a87cbe7201ddd7c97e2c61f828863054d) Fix small typo in README.md
- [`2cfd2ea`](https://github.com/bencheeorg/benchee/commit/2cfd2ea8f58c5cba9cf005ca2c6938c8c2eb7d5e) New README sample HTML Report
- [`f27168b`](https://github.com/bencheeorg/benchee/commit/f27168bf8f4d8958022a40f591fe551e99358b67) And this shall be 1.0 :tada:
- [`7a5f2a1`](https://github.com/bencheeorg/benchee/commit/7a5f2a10080a13c2c3537874dedac1662c890bac) no more unit_scaling warning
- [`da7d933`](https://github.com/bencheeorg/benchee/commit/da7d933fc78f4225fb8f33bf14709a96f154eea3) No more warning about unsupported Erlangs
- [`504a6c6`](https://github.com/bencheeorg/benchee/commit/504a6c6eedeb7aa6fe3f4e0912744ec1e854dc09) Remove all deprecated functionality
- [`f85e3db`](https://github.com/bencheeorg/benchee/commit/f85e3db06769500dea9fc99e0ddc52aec6a8ef90) ugh there was documentation missing :scream:
- Additional commits viewable in [compare view](https://github.com/PragTob/benchee/compare/0.14.0...1.0.1)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot ignore this [patch|minor|major] version` will close this PR and stop Dependabot creating any more for this minor/major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
- `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language
- `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language
- `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language
- `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language
- `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme
Additionally, you can set the following in your Dependabot [dashboard](https://app.dependabot.com):
- Update frequency (including time of day and day of week)
- Automerge options (never/patch/minor, and dev/runtime dependencies)
- Pull request limits (per update run and/or open at any time)
- Out-of-range updates (receive only lockfile updates, if desired)
- Security updates (receive only security updates, if desired)
Finally, you can contact us by mentioning @dependabot.
Bumps benchee from 0.14.0 to 1.0.1.
Release notes
*Sourced from [benchee's releases](https://github.com/PragTob/benchee/releases).* > ## 1.0.1 > ### Bugfixes (User Facing) > * When memory measurements were actually different extended statistics was displayed although the option was not provided. Now correctly only displayed if the option is provided and values actually had variance. > > ## 1.0.0 > It's 0.99.0 without the deprecation warnings. Specifically: > > * Old way of passing formatters (`:formatter_options`) vs. new `:formatters` with modules, tuples or functions with one arg > * The configuration needs to be passed as the second argument to `Benchee.run/2` > * `Benchee.collect/1` replaces `Benchee.measure/1` > * `unit_scaling` is a top level configuration option, not for the console formatter > * the warning for memory measurements not working on OTP <= 18 will also be dropped (we already officially dropped OTP 18 support in 0.14.0) > > We're aiming to follow Semantic Versioning as we go forward. That means formatters should be safe to use `~> 1.0` (or even `>= 0.99.0 and < 2.0.0`). > > ## 0.99.0 > The "we're almost 1.0!" release - all the last small features, a bag of polish and deprecation warnings. If you run this release succesfully without deprecation warnings you should be safe to upgrade to 1.0.0, if not - it's a bug :) > > ### Breaking Changes (User Facing) > * changed official Elixir compatibility to `~> 1.6`, 1.4+ should still work but aren't guaranteed or tested against. > > ### Features (User Facing) > * the console comparison now also displays the absolute difference in the average (like +12 ms) so that you have an idea to how much time that translates to in your applications not just that it's 100x faster > * Overhaul of README, documentation, update samples etc. - a whole lot of things have also been marked `[@doc](https://github.com/doc) false` as they're considered internal > > ### Bugfixes (User Facing) > * Remove double empty line after configuration display > * Fix some wrong type specs > > ### Breaking Changes (Plugins) > * `Scenario` made it to the big leagues, it's no longer `Benchee.Benchmark.Scenario` but `Benchee.Scenario` - as it is arguably one of our most important data structures. > * The `Scenario` struct had some keys changed (last time before 2.0 I promise!) - instead of `:run_times`/`:run_time_statistics` you now have one `run_time_data` key that contains `Benchee.CollectionData` which has the keys `:samples` and `:statistics`. Same for `memory_usage`. This was done to be able to handle different kinds of measurements more uniformly as we will add more of them. > > ### Features (Plugins) > * `Benchee.Statistics` comes with 3 new values: `:relative_more`, `:relative_less`, `:absolute_difference` so that you don't have to calculate these relative values yourself :)Changelog
*Sourced from [benchee's changelog](https://github.com/bencheeorg/benchee/blob/master/CHANGELOG.md).* > ## 1.0.1 (2019-04-09) > > ### Bugfixes (User Facing) > * When memory measurements were actually different extended statistics was displayed although the option was not provided. Now correctly only displayed if the option is provided and values actually had variance. > > ## 1.0.0 (2019-03-28) > > It's 0.99.0 without the deprecation warnings. Specifically: > > * Old way of passing formatters (`:formatter_options`) vs. new `:formatters` with modules, tuples or functions with one arg > * The configuration needs to be passed as the second argument to `Benchee.run/2` > * `Benchee.collect/1` replaces `Benchee.measure/1` > * `unit_scaling` is a top level configuration option, not for the console formatter > * the warning for memory measurements not working on OTP <= 18 will also be dropped (we already officially dropped OTP 18 support in 0.14.0) > > We're aiming to follow Semantic Versioning as we go forward. That means formatters should be safe to use `~> 1.0` (or even `>= 0.99.0 and < 2.0.0`). > > ## 0.99.0 (2019-03-28) > > The "we're almost 1.0!" release - all the last small features, a bag of polish and deprecation warnings. If you run this release succesfully without deprecation warnings you should be safe to upgrade to 1.0.0, if not - it's a bug :) > > ### Breaking Changes (User Facing) > * changed official Elixir compatibility to `~> 1.6`, 1.4+ should still work but aren't guaranteed or tested against. > > ### Features (User Facing) > * the console comparison now also displays the absolute difference in the average (like +12 ms) so that you have an idea to how much time that translates to in your applications not just that it's 100x faster > * Overhaul of README, documentation, update samples etc. - a whole lot of things have also been marked `[@doc](https://github.com/doc) false` as they're considered internal > > ### Bugfixes (User Facing) > * Remove double empty line after configuration display > * Fix some wrong type specs > > ### Breaking Changes (Plugins) > * `Scenario` made it to the big leagues, it's no longer `Benchee.Benchmark.Scenario` but `Benchee.Scenario` - as it is arguably one of our most important data structures. > * The `Scenario` struct had some keys changed (last time before 2.0 I promise!) - instead of `:run_times`/`:run_time_statistics` you now have one `run_time_data` key that contains `Benchee.CollectionData` which has the keys `:samples` and `:statistics`. Same for `memory_usage`. This was done to be able to handle different kinds of measurements more uniformly as we will add more of them. > > ### Features (Plugins) > * `Benchee.Statistics` comes with 3 new values: `:relative_more`, `:relative_less`, `:absolute_difference` so that you don't have to calculate these relative values yourself :)Commits
- [`87129ba`](https://github.com/bencheeorg/benchee/commit/87129baa2310524a371105a4f211cac3d4dc122c) prepare for a release of the bugfix - [`51d2a22`](https://github.com/bencheeorg/benchee/commit/51d2a22fe25cf2fa3cefdc378590128367c38994) Sample where memory consumption is actually changing - [`72cd7bc`](https://github.com/bencheeorg/benchee/commit/72cd7bc60bdb8983961c4475ab2749cbdb4bd27a) Only show extended memory statistics when requested - [`408ca94`](https://github.com/bencheeorg/benchee/commit/408ca94a87cbe7201ddd7c97e2c61f828863054d) Fix small typo in README.md - [`2cfd2ea`](https://github.com/bencheeorg/benchee/commit/2cfd2ea8f58c5cba9cf005ca2c6938c8c2eb7d5e) New README sample HTML Report - [`f27168b`](https://github.com/bencheeorg/benchee/commit/f27168bf8f4d8958022a40f591fe551e99358b67) And this shall be 1.0 :tada: - [`7a5f2a1`](https://github.com/bencheeorg/benchee/commit/7a5f2a10080a13c2c3537874dedac1662c890bac) no more unit_scaling warning - [`da7d933`](https://github.com/bencheeorg/benchee/commit/da7d933fc78f4225fb8f33bf14709a96f154eea3) No more warning about unsupported Erlangs - [`504a6c6`](https://github.com/bencheeorg/benchee/commit/504a6c6eedeb7aa6fe3f4e0912744ec1e854dc09) Remove all deprecated functionality - [`f85e3db`](https://github.com/bencheeorg/benchee/commit/f85e3db06769500dea9fc99e0ddc52aec6a8ef90) ugh there was documentation missing :scream: - Additional commits viewable in [compare view](https://github.com/PragTob/benchee/compare/0.14.0...1.0.1)Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot ignore this [patch|minor|major] version` will close this PR and stop Dependabot creating any more for this minor/major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) - `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language - `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language - `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language - `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language - `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme Additionally, you can set the following in your Dependabot [dashboard](https://app.dependabot.com): - Update frequency (including time of day and day of week) - Automerge options (never/patch/minor, and dev/runtime dependencies) - Pull request limits (per update run and/or open at any time) - Out-of-range updates (receive only lockfile updates, if desired) - Security updates (receive only security updates, if desired) Finally, you can contact us by mentioning @dependabot.