gobenchdata

• deps: various dependency upgrades

Full Changelog: https://github.com/bobheadxi/gobenchdata/compare/v1...v1.3.1

What's Changed

• entrypoint.sh: update setting output by @srenatus in https://github.com/bobheadxi/gobenchdata/pull/68
• workflows: upgrade to codecov/codecov-action@v3, only run demo-publish on main by @bobheadxi in https://github.com/bobheadxi/gobenchdata/pull/72
• checks: fix evaluation against latest run in base by @bobheadxi in https://github.com/bobheadxi/gobenchdata/pull/71
• entrypoint.sh: set pipefail to fail action if go test -bench fails by @bobheadxi in https://github.com/bobheadxi/gobenchdata/pull/73

New Contributors

• @srenatus made their first contribution in https://github.com/bobheadxi/gobenchdata/pull/68

Full Changelog: https://github.com/bobheadxi/gobenchdata/compare/v1.2.2...v1.3.0

What's Changed

• Fixed custom action example
• Added go-recipes badge by @nikolaydubina in https://github.com/bobheadxi/gobenchdata/pull/67

New Contributors

• @nikolaydubina made their first contribution in https://github.com/bobheadxi/gobenchdata/pull/67

Full Changelog: https://github.com/bobheadxi/gobenchdata/compare/v1...v1.2.2

What's Changed

• web: explicitly register @markerClick event (fixes https://github.com/bobheadxi/gobenchdata/issues/61)

Full Changelog: https://github.com/bobheadxi/gobenchdata/compare/v1...v1.2.1

What's Changed

• cli: add 'gobenchdata action' to use gobenchdata action with custom Go versions by @bobheadxi in https://github.com/bobheadxi/gobenchdata/pull/62
• cli: add -require-benchmarks by @bobheadxi in https://github.com/bobheadxi/gobenchdata/pull/63
• all: build with go1.18, upgrade dependencies (https://github.com/bobheadxi/gobenchdata/commit/ea0e521c9b2163e6685a927e3b110441c5651bc2)

Full Changelog: https://github.com/bobheadxi/gobenchdata/compare/v1...v1.2.0

What's Changed

• web: upgrade to vue3 by @bobheadxi in https://github.com/bobheadxi/gobenchdata/pull/56
• cli: eval now prints pretty report instead of json if -json not set by @bobheadxi in https://github.com/bobheadxi/gobenchdata/pull/53

Full Changelog: https://github.com/bobheadxi/gobenchdata/compare/v1...v1.1.0

For more details about recent changes, see the v1.0.0 release.

What's Changed

• bench: evaluate mem.BytesPerOp, mem.AllocsPerOp as float64 by @bobheadxi in https://github.com/bobheadxi/gobenchdata/pull/58 - this fixes checks defined on mem.BytesPerOp and mem.AllocsPerOp involving division incorrectly evaluating to a truncated integer value.

Full Changelog: https://github.com/bobheadxi/gobenchdata/compare/v1...v1.0.4

For more details about recent changes, see the v1.0.0 release.

What's Changed

• cli: print and exit instead of panic on error, improve benchmark read failure error by @bobheadxi in https://github.com/bobheadxi/gobenchdata/pull/52
• deps: update dependencies

Full Changelog: https://github.com/bobheadxi/gobenchdata/compare/v1...v1.0.3

For more details about recent changes, see the v1.0.0 release.

What's Changed

• Fix Parser panic when runner reports cpu by @piotrekmonko in https://github.com/bobheadxi/gobenchdata/pull/49
• deps: upgrade to go1.17, upgrade libraries by @bobheadxi in https://github.com/bobheadxi/gobenchdata/pull/46
• chore: publish images by @bobheadxi in https://github.com/bobheadxi/gobenchdata/pull/50

New Contributors

• @piotrekmonko made their first contribution in https://github.com/bobheadxi/gobenchdata/pull/49

Full Changelog: https://github.com/bobheadxi/gobenchdata/compare/v1.0.1...v1.0.2

This release fixes a bug where checks would fail when no base benchmarks have been recorded.

For more details about recent changes, see the v1.0.0 release.

This release brings some big new features :)

:shipit: Improved Publishing

• ⚠️ Breaking change - PUBLISH: true must now be set to enable publishing
  • to continue using older versions of gobenchdata please pin your workflow to use bobheadxi/[email protected]!
• Publish results to any branch in any repository with PUBLISH_REPO and PUBLISH_BRANCH (just make sure env.GITHUB_TOKEN has the necessary permissions)
  • these are optional - the default behaviour remains the same (pushes to the host repository's gh-pages branch)

    - name: gobenchdata publish
      uses: bobheadxi/gobenchdata@v1
      with:
        PRUNE_COUNT: 30
        PUBLISH: true
        PUBLISH_REPO: bobheadxi/gobenchdata-v1-demo
        PUBLISH_BRANCH: master
      env:
        GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}

✅ Checks

You can now define checks on benchmark results and check for regressions in pull requests.

• Configure checks with gobenchdata-checks.yml - get started with gobenchdata checks generate
  • define your own arithmetic for interpreting results - for example:

      diff: (current.NsPerOp-base.NsPerOp) / base.NsPerOp * 100
      thresholds:
            max: 10

• Run checks locally or in GitHub Actions
  • locally: gobenchdata checks eval - output can be output nicely with --checks.pretty, or saved with --json
    • JSON reports can be summarized with gobenchdata checks report
  • in GitHub Actions:

    - name: gobenchdata checks
      uses: bobheadxi/gobenchdata@v1
      with:
        GO_TEST_FLAGS: -cpu 1,2
        CHECKS: true
        CHECKS_CONFIG: ./demo/gobenchdata-checks.yml
        PUBLISH_BRANCH: master
      env:
        GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}

📉 New Web Application

The web application has been rewritten from the ground up!

• Now embedded in the core gobenchdata CLI
  • try it out with gobenchdata web serve!
  • generate a new app with gobenchdata web generate ./app
• Improved visualizations
  • charts are now built with ApexCharts, which brings built-in chart navigation, image generation, clearer tooltips, and more
• Improved configuration
  • define groups of charts, specify benchmarks and metrics to display, and include instructions for interpretation with the new gobenchdata-web.yml configuration format

Migrating from v0.5.x

Existing Actions

- uses: bobheadxi/[email protected]
+ uses: bobheadxi/gobenchdata@v1

with:
+ PUBLISH: true

Regenerating the Web App

Copy the title and description you are using to a temporary file. Delete app.js, index.html, style.css. Then:

go get -u go.bobheadxi.dev/gobenchdata
gobenchdata web generate . --web.title="My title"

Then, in gobenchdata-web.yml, add your description to the description field. Without configuring any chartGroups, the web app should generate similar charts to before - to start customizing, add some entries to chartGroups!

x/web

• update ChartJS to v2.9.3
• fix bug with generating charts on custom benchmarks

x/web

• add --per-benchmark flag to disable grouping benchmarks by package (#30 by @JRascagneres)
• if no commit information is provided, a link is no longer generated (#24)

misc

• improvements to the action image (#23)
• documentation improvements, links to examples

Minor patch - see v0.4.0 for full changelog!

x/web

• fix link to gobenchdata GitHub action

This release is a pretty significant update that brings the gobenchdata action in line with the new GitHub Actions features and format! 🎉 Highlights of this release include:

action

• new name ("Continuous Benchmarking for Go") because GitHub won't let me publish under the old one 😢
• configuration is now via inputs rather than env, as defined in action.yml
• improved configuration output during run
• new configuration options like SUBDIRECTORY

gobenchdata

• support for custom metrics out of the box (new metrics are added to the field Benchmark.Custom)
• fixed support for metrics that output float values

x/gobenchdata-web

• support for custom metrics when generating new web apps using the --charts-types option (e.g. -c bytes/op,allocs/op,custom/op)
• support for canonical imports with --source and --canonical-import
• guidelines now appear on hover for runs
• tweaked styling
• fixed support for new benchmarks (previously, new benchmarks would not render)

docs

• new and better examples using the new YAML format for workflows

For more details refer to the full diff.

The new import path is now:

go get go.bobheadxi.dev/gobenchdata/...

x/gobenchdata-web

• allow HTML in description (--desc)

gobenchdata

• new --prune option (in the Action, PRUNE) for automatically removing old benchmarks

x/gobenchdata-web

• new --desc option when generating app
• new --root-import option to allow:
• package names to link to github
• data points to link to specific commits
• improved formatting and spacing

all changes: diff

gobenchdata

• more manageable storage format with --flat
• bug fixes

x/gobenchdata-web

• significant improvements in charts and generation

all changes: diff

Fix up a typo in the description. OOps