Use criterion-cmp

I extracted criterion-compare-txt into separate package
https://hackage.haskell.org/package/criterion-cmp

I found it uselul elsewhere as well, and now as I fixed
a alignment issue which bothered me, let have it separately available.

Author: phadej

.github/workflows/z-bench.yml

@@ -125,7 +125,6 @@ jobs:
         run: |
           touch cabal.project
           echo "packages: $GITHUB_WORKSPACE/source/benchmarks" >> cabal.project
-          echo "packages: $GITHUB_WORKSPACE/source/criterion-compare-txt" >> cabal.project
           cat cabal.project
       - name: sdist
         run: |
@@ -139,19 +138,14 @@ jobs:
         run: |
           PKGDIR_aeson_benchmarks="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/aeson-benchmarks-[0-9.]*')"
           echo "PKGDIR_aeson_benchmarks=${PKGDIR_aeson_benchmarks}" >> $GITHUB_ENV
-          PKGDIR_criterion_compare_txt="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/criterion-compare-txt-[0-9.]*')"
-          echo "PKGDIR_criterion_compare_txt=${PKGDIR_criterion_compare_txt}" >> $GITHUB_ENV
           touch cabal.project
           touch cabal.project.local
           echo "packages: ${PKGDIR_aeson_benchmarks}" >> cabal.project
-          echo "packages: ${PKGDIR_criterion_compare_txt}" >> cabal.project
           if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "package aeson-benchmarks" >> cabal.project ; fi
           if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "    ghc-options: -Werror=missing-methods" >> cabal.project ; fi
-          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "package criterion-compare-txt" >> cabal.project ; fi
-          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "    ghc-options: -Werror=missing-methods" >> cabal.project ; fi
           cat >> cabal.project <<EOF
           EOF
-          $HCPKG list --simple-output --names-only | perl -ne 'for (split /\s+/) { print "constraints: $_ installed\n" unless /^(aeson-benchmarks|criterion-compare-txt)$/; }' >> cabal.project.local
+          $HCPKG list --simple-output --names-only | perl -ne 'for (split /\s+/) { print "constraints: $_ installed\n" unless /^(aeson-benchmarks)$/; }' >> cabal.project.local
           cat cabal.project
           cat cabal.project.local
       - name: dump install plan
@@ -174,7 +168,3 @@ jobs:
       - name: build
         run: |
           $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH all --write-ghc-environment-files=always
-      - name: unconstrained build
-        run: |
-          rm -f cabal.project.local
-          $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks all

CONTRIBUTING.md

@@ -99,10 +99,10 @@ Of course before submitting a PR, the following steps are recommended:
 
 ### Running benchmarks
 
-You need to install `cabal-plan`:
+You need to install `cabal-plan` and `criterion-cmp`:
 
 ```
-cabal install cabal-plan
+cabal install cabal-plan criterion-cmp
 ```
 
 Then to build benchmarks we use a different project, which builds
@@ -121,13 +121,13 @@ git checkout your-branch
 which will output a table like
 
 ```
-Benchmark                              master  your-branch
-Examples/decode/github-issues/lazy    1.77e-3      1.76e-3  -0.68%
-Examples/decode/github-issues/strict  1.75e-3      1.69e-3  -3.29%
-Examples/decode/jp100/lazy            1.97e-3      1.98e-3  +0.43%
-Examples/decode/jp100/strict          1.94e-3      1.96e-3  +1.10%
-Examples/decode/twitter100/lazy       1.54e-3      1.59e-3  +2.98%
-Examples/decode/twitter100/strict     1.51e-3      1.51e-3  -0.20%
+Benchmark                             master   your-branch
+Examples/decode/github-issues/lazy    1.77e-3  1.76e-3 -0.68%
+Examples/decode/github-issues/strict  1.75e-3  1.69e-3 -3.29%
+Examples/decode/jp100/lazy            1.97e-3  1.98e-3 +0.43%
+Examples/decode/jp100/strict          1.94e-3  1.96e-3 +1.10%
+Examples/decode/twitter100/lazy       1.54e-3  1.59e-3 +2.98%
+Examples/decode/twitter100/strict     1.51e-3  1.51e-3 -0.20%
 ```
 
 Run `./bench.sh help` for more details.

bench.sh

@@ -108,7 +108,7 @@ cmdBuild() {
     # Building
     putInfo "Building benchmarks"
 
-    command cabal build --project-file cabal.bench.project -w "$HC"  aeson-benchmark-suite criterion-compare-txt
+    command cabal build --project-file cabal.bench.project -w "$HC"  aeson-benchmark-suite
 }
 
 # run
@@ -197,10 +197,6 @@ cmdCompare() {
         esac
     done
 
-    # Building
-    putInfo "Building criterion-compare-txt"
-    command cabal build --project-file cabal.bench.project -w "$HC" criterion-compare-txt
-
 	# Comparing th eresults
     putInfo "Comparing runs:$RUNS"
 
@@ -211,7 +207,7 @@ cmdCompare() {
     done
 
     # shellcheck disable=SC2086
-    command "$(cabal-plan list-bin criterion-compare-txt)" $CSV
+    command "criterion-cmp" $CSV
 }
 
 # main

cabal.bench.haskell-ci

@@ -3,3 +3,4 @@ github-action-name: Z Bench CI
 branches:           master
 haddock:            False
 cabal-check:        False
+unconstrained:      False

cabal.bench.project

@@ -1,4 +1,3 @@
 with-compiler: ghc
 packages: benchmarks/
-packages: criterion-compare-txt/
 tests: false