chore(bench): display bench stats as comment in PR

Fixes #992

Signed-off-by: Xavier Coulon <[email protected]>

.github/workflows/ci-bench.yml

@@ -1,20 +1,15 @@
-name: ci-build
+name: ci-bench
 on:
-  push:
-    branches:
-      - master
-    tags-ignore:
-      - '*.*'
-  pull_request:
+  pull_request_target:
     branches:
       - master
 
 jobs:
-  test:
+  bench:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        go-version: [1.16.x,1.17.x]
+        go-version: [1.17.x]
         os: [ubuntu-latest]
     name: Benchstat with Go ${{ matrix.go-version }}
 
@@ -38,11 +33,25 @@ jobs:
           ${{ runner.os }}-go-
 
     - name: Verify parser
-      if: runner.os == 'Linux'
       run: |
         make verify-parser
 
     - name: Bench and Diff
+      id: bench-diff
       run: |
         go install golang.org/x/perf/cmd/benchstat@latest
         make bench-diff
+        echo "::set-output name=summary::$(make print-bench-diff)"
+
+    - name: Comment Benchmark Diffs
+      uses: marocchino/sticky-pull-request-comment@v2
+      with:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        header: bench
+        message: |
+          ### Benchmark Diffs
+          <details><summary>Benchmark diffs</summary>
+          ```
+          ${{ steps.bench-diff.outputs.summary }}
+          ```
+          </details>

.github/workflows/ci-release.yml

@@ -1,4 +1,4 @@
-name: goreleaser
+name: ci-release
 
 on:
   push:

make/bench.mk

@@ -33,13 +33,15 @@ bench-diff: clean generate-optimized check-git-status
 		| tee $(REPORTS_DIR)/v0.7.0.bench
 	@echo "generated $(REPORTS_DIR)/v0.7.0.bench"
 	@git checkout $(GIT_BRANCH_NAME)
-	@echo ""
 	@echo "Comparing with 'master' branch"
 	@$(GOPATH)/bin/benchstat $(REPORTS_DIR)/$(GIT_BRANCH_NAME)-$(GIT_COMMIT_ID_SHORT).bench $(REPORTS_DIR)/master.bench
 	@echo ""
 	@echo "Comparing with 'v0.7.0' tag"
-	@$(GOPATH)/bin/benchstat $(REPORTS_DIR)/$(GIT_BRANCH_NAME)-$(GIT_COMMIT_ID_SHORT).bench $(REPORTS_DIR)/v0.7.0.bench
+	@$(GOPATH)/bin/benchstat $(REPORTS_DIR)/$(GIT_BRANCH_NAME)-$(GIT_COMMIT_ID_SHORT).bench $(REPORTS_DIR)/v0.7.0.bench | tee $(REPORTS_DIR)/diffs.txt
 
+print-bench-diff:
+	@cat $(REPORTS_DIR)/diffs.txt
+
 check-git-status:
 ifneq ("$(shell git status --porcelain)","")
 	@echo "Repository contains uncommitted changes:"