benchmark.yml

name: Benchmark
on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  benchmark:
    name: Performance regression check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-go@v1

      # Run benchmark with `go test -bench` and stores the output to a file
      - name: Run benchmark
        run: go test -bench=. ./go_bench | tee output.txt

      # Download previous benchmark result from cache (if exists)
      - name: Download previous benchmark data
        uses: actions/cache@v1
        with:
          path: ./cache
          key: ${{ runner.os }}-benchmark

      # Run `github-action-benchmark` action
      - name: Store benchmark result
        uses: benchmark-action/github-action-benchmark@v1
        with:
          # What benchmark tool the output.txt came from
          tool: 'go'

          # Where the output from the benchmark tool is stored
          output-file-path: output.txt

          # Where the previous data file is stored
          external-data-json-path: ./cache/benchmark-data.json

          alert-threshold: '100%'
          fail-on-alert: true
          comment-on-alert: true
          # alert-comment-cc-users: '@SupunS'
          github-token: ${{ secrets.GITHUB_TOKEN }}
          # auto-push: true