action.yml

name: Continuous Benchmarking for Go
author: Robert Lin <robert@bobheadxi.dev>
description: Run Go benchmarks, publish results to an interactive web app, and check for performance regressions in your pull requests!
branding:
  icon: activity
  color: white
runs:
  using: docker
  image: Dockerfile

# see https://github.com/bobheadxi/gobenchdata#github-action for more details
inputs:
  # shared
  SUBDIRECTORY:
    description: subdirectory of project to run commands from
    default: '.'
    required: false
  GO_BENCHMARKS:
    description: benchmarks to run (argument for `-bench`)
    default: '.'
    required: false
  GO_TEST_FLAGS:
    description: additional flags for `go test`
    required: false
  GO_TEST_PKGS:
    description: packages to test (argument for `go test`)
    default: './...'
    required: false
  BENCHMARKS_OUT:
    description: destination path of benchmark data
    default: 'benchmarks.json'
    required: false
  PUBLISH_REPO:
    description: repository base branch results are published to
    required: false
  PUBLISH_BRANCH:
    default: 'gh-pages'
    description: branch results are published to
    required: false
  GOBENCHDATA_PARSE_FLAGS:
    description: additional flags to pass to gobenchdata when parsing benchmark data
    required: false
  # publishing
  PUBLISH:
    default: "false"
    description: enable publishing of benchmark results
    required: false
  PRUNE_COUNT:
    description: number of past runs to keep (`0` keeps everything)
    default: "0"
    required: false
  GIT_COMMIT_MESSAGE:
    description: the commit message for the benchmark update
    required: false
  # checks
  CHECKS:
    description: enable checks on benchmark results
    default: "false"
    required: false
  CHECKS_CONFIG:
    default: 'gobenchdata-checks.yml'
    description: path to checks configuration
    required: false