Regenerate CI

Elaborate documentation for nfIO / whnfIO
2024-07-14 19:00:34 +03:00 · 2024-03-16 23:12:09 +00:00 · 2024-03-16 22:56:42 +00:00
7 changed files with 60 additions and 29 deletions
--- a/.cirrus.yml
+++ b/.cirrus.yml
@ -1,7 +1,7 @@
 task:
  name: FreeBSD
  freebsd_instance:
-    image_family: freebsd-13-1
+    image_family: freebsd-13-2
  install_script: pkg install -y ghc hs-cabal-install git
  script:
    - cabal update
--- a/.github/workflows/haskell-ci.yml
+++ b/.github/workflows/haskell-ci.yml
@ -8,9 +8,9 @@
 #
 # For more information, see https://github.com/haskell-CI/haskell-ci
 #
-# version: 0.17.20231010
+# version: 0.19.20240316
 #
-# REGENDATA ("0.17.20231010",["github","tasty-bench.cabal"])
+# REGENDATA ("0.19.20240316",["github","tasty-bench.cabal"])
 #
 name: Haskell-CI
 on:
@ -28,19 +28,24 @@ jobs:
    strategy:
      matrix:
        include:
-          - compiler: ghc-9.8.1
+          - compiler: ghc-9.10.0.20240313
            compilerKind: ghc
-            compilerVersion: 9.8.1
+            compilerVersion: 9.10.0.20240313
            setup-method: ghcup
            allow-failure: false
-          - compiler: ghc-9.6.3
+          - compiler: ghc-9.8.2
            compilerKind: ghc
-            compilerVersion: 9.6.3
+            compilerVersion: 9.8.2
            setup-method: ghcup
            allow-failure: false
-          - compiler: ghc-9.4.7
+          - compiler: ghc-9.6.4
            compilerKind: ghc
-            compilerVersion: 9.4.7
+            compilerVersion: 9.6.4
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-9.4.8
+            compilerKind: ghc
+            compilerVersion: 9.4.8
            setup-method: ghcup
            allow-failure: false
          - compiler: ghc-9.2.8
@ -121,18 +126,20 @@ jobs:
          apt-get install -y --no-install-recommends gnupg ca-certificates dirmngr curl git software-properties-common libtinfo5
          if [ "${{ matrix.setup-method }}" = ghcup ]; then
            mkdir -p "$HOME/.ghcup/bin"
-            curl -sL https://downloads.haskell.org/ghcup/0.1.19.5/x86_64-linux-ghcup-0.1.19.5 > "$HOME/.ghcup/bin/ghcup"
+            curl -sL https://downloads.haskell.org/ghcup/0.1.20.0/x86_64-linux-ghcup-0.1.20.0 > "$HOME/.ghcup/bin/ghcup"
            chmod a+x "$HOME/.ghcup/bin/ghcup"
+            "$HOME/.ghcup/bin/ghcup" config add-release-channel https://raw.githubusercontent.com/haskell/ghcup-metadata/master/ghcup-prereleases-0.0.8.yaml;
            "$HOME/.ghcup/bin/ghcup" install ghc "$HCVER" || (cat "$HOME"/.ghcup/logs/*.* && false)
-            "$HOME/.ghcup/bin/ghcup" install cabal 3.10.1.0 || (cat "$HOME"/.ghcup/logs/*.* && false)
+            "$HOME/.ghcup/bin/ghcup" install cabal 3.10.2.0 || (cat "$HOME"/.ghcup/logs/*.* && false)
          else
            apt-add-repository -y 'ppa:hvr/ghc'
            apt-get update
            apt-get install -y "$HCNAME"
            mkdir -p "$HOME/.ghcup/bin"
-            curl -sL https://downloads.haskell.org/ghcup/0.1.19.5/x86_64-linux-ghcup-0.1.19.5 > "$HOME/.ghcup/bin/ghcup"
+            curl -sL https://downloads.haskell.org/ghcup/0.1.20.0/x86_64-linux-ghcup-0.1.20.0 > "$HOME/.ghcup/bin/ghcup"
            chmod a+x "$HOME/.ghcup/bin/ghcup"
-            "$HOME/.ghcup/bin/ghcup" install cabal 3.10.1.0 || (cat "$HOME"/.ghcup/logs/*.* && false)
+            "$HOME/.ghcup/bin/ghcup" config add-release-channel https://raw.githubusercontent.com/haskell/ghcup-metadata/master/ghcup-prereleases-0.0.8.yaml;
+            "$HOME/.ghcup/bin/ghcup" install cabal 3.10.2.0 || (cat "$HOME"/.ghcup/logs/*.* && false)
          fi
        env:
          HCKIND: ${{ matrix.compilerKind }}
@ -152,20 +159,20 @@ jobs:
            echo "HC=$HC" >> "$GITHUB_ENV"
            echo "HCPKG=$HCPKG" >> "$GITHUB_ENV"
            echo "HADDOCK=$HADDOCK" >> "$GITHUB_ENV"
-            echo "CABAL=$HOME/.ghcup/bin/cabal-3.10.1.0 -vnormal+nowrap" >> "$GITHUB_ENV"
+            echo "CABAL=$HOME/.ghcup/bin/cabal-3.10.2.0 -vnormal+nowrap" >> "$GITHUB_ENV"
          else
            HC=$HCDIR/bin/$HCKIND
            echo "HC=$HC" >> "$GITHUB_ENV"
            echo "HCPKG=$HCDIR/bin/$HCKIND-pkg" >> "$GITHUB_ENV"
            echo "HADDOCK=$HCDIR/bin/haddock" >> "$GITHUB_ENV"
-            echo "CABAL=$HOME/.ghcup/bin/cabal-3.10.1.0 -vnormal+nowrap" >> "$GITHUB_ENV"
+            echo "CABAL=$HOME/.ghcup/bin/cabal-3.10.2.0 -vnormal+nowrap" >> "$GITHUB_ENV"
          fi

          HCNUMVER=$(${HC} --numeric-version|perl -ne '/^(\d+)\.(\d+)\.(\d+)(\.(\d+))?$/; print(10000 * $1 + 100 * $2 + ($3 == 0 ? $5 != 1 : $3))')
          echo "HCNUMVER=$HCNUMVER" >> "$GITHUB_ENV"
          echo "ARG_TESTS=--enable-tests" >> "$GITHUB_ENV"
          echo "ARG_BENCH=--enable-benchmarks" >> "$GITHUB_ENV"
-          echo "HEADHACKAGE=false" >> "$GITHUB_ENV"
+          if [ $((HCNUMVER >= 91000)) -ne 0 ] ; then echo "HEADHACKAGE=true" >> "$GITHUB_ENV" ; else echo "HEADHACKAGE=false" >> "$GITHUB_ENV" ; fi
          echo "ARG_COMPILER=--$HCKIND --with-compiler=$HC" >> "$GITHUB_ENV"
          echo "GHCJSARITH=0" >> "$GITHUB_ENV"
        env:
@ -194,6 +201,18 @@ jobs:
          repository hackage.haskell.org
            url: http://hackage.haskell.org/
          EOF
+          if $HEADHACKAGE; then
+          cat >> $CABAL_CONFIG <<EOF
+          repository head.hackage.ghc.haskell.org
+             url: https://ghc.gitlab.haskell.org/head.hackage/
+             secure: True
+             root-keys: 7541f32a4ccca4f97aea3b22f5e593ba2c0267546016b992dfadcd2fe944e55d
+                        26021a13b401500c8eb2761ca95c61f2d625bfef951b939a8124ed12ecf07329
+                        f76d08be13e9a61a377a85e2fb63f4c5435d40f8feb3e12eb05905edb8cdea89
+             key-threshold: 3
+          active-repositories: hackage.haskell.org, head.hackage.ghc.haskell.org:override
+          EOF
+          fi
          cat >> $CABAL_CONFIG <<EOF
          program-default-options
            ghc-options: $GHCJOBS +RTS -M3G -RTS
@ -245,6 +264,9 @@ jobs:
          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "    ghc-options: -Werror=missing-methods" >> cabal.project ; fi
          cat >> cabal.project <<EOF
          EOF
+          if $HEADHACKAGE; then
+          echo "allow-newer: $($HCPKG list --simple-output | sed -E 's/([a-zA-Z-]+)-[0-9.]+/*:\1,/g')" >> cabal.project
+          fi
          $HCPKG list --simple-output --names-only | perl -ne 'for (split /\s+/) { print "constraints: $_ installed\n" unless /^(tasty-bench)$/; }' >> cabal.project.local
          cat cabal.project
          cat cabal.project.local
--- a/.github/workflows/other.yml
+++ b/.github/workflows/other.yml
@ -13,17 +13,17 @@ jobs:
    strategy:
      fail-fast: true
      matrix:
-        os: [windows-latest, macOS-latest]
+        os: [windows-latest, macOS-latest, macOS-14]
        ghc: ['latest']
    steps:
-    - uses: actions/checkout@v3
-    - uses: haskell/actions/setup@v2
+    - uses: actions/checkout@v4
+    - uses: haskell-actions/setup@v2
      id: setup-haskell-cabal
      with:
        ghc-version: ${{ matrix.ghc }}
    - name: Update cabal package database
      run: cabal update
-    - uses: actions/cache@v3
+    - uses: actions/cache@v4
      name: Cache cabal stuff
      with:
        path: |
@ -54,8 +54,8 @@ jobs:
      matrix:
        arch: ['s390x', 'ppc64le', 'armv7', 'aarch64']
    steps:
-    - uses: actions/checkout@v3
-    - uses: uraimo/run-on-arch-action@v2.5.0
+    - uses: actions/checkout@v4
+    - uses: uraimo/run-on-arch-action@v2.7.1
      with:
        arch: ${{ matrix.arch }}
        distro: ubuntu_rolling
@ -98,9 +98,9 @@ jobs:
        curl -L https://gitlab.haskell.org/ghc/ghc-wasm-meta/-/archive/$GHC_WASM_META_REV/ghc-wasm-meta-master.tar.gz | tar xz --strip-components=1
        ./setup.sh
        ~/.ghc-wasm/add_to_github_path.sh
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4

-    - uses: actions/cache@v3
+    - uses: actions/cache@v4
      with:
        path: |
          ~/.ghc-wasm/.cabal/store
--- a/README.md
+++ b/README.md
@ -42,7 +42,7 @@ is up to 6x faster than `criterion` and up to 8x faster than `gauge`.
 `tasty-bench` is a native Haskell library and works everywhere, where GHC
 does, including WASM. We support a full range of architectures (`i386`, `amd64`, `armhf`,
 `arm64`, `ppc64le`, `s390x`) and operating systems (Linux, Windows, macOS,
-FreeBSD, OpenBSD, NetBSD), plus any GHC from 7.0 to 9.8.
+FreeBSD, OpenBSD, NetBSD), plus any GHC from 7.0 to 9.10.

 ## How is it possible?

--- a/changelog.md
+++ b/changelog.md
@ -7,6 +7,7 @@
  benchmarking overhead in many scenarios and brings the behaviour in line
  with `criterion`. See [#39](https://github.com/Bodigrim/tasty-bench/issues/39)
  for discussion.
+* Drop support of `tasty < 1.4`.

 # 0.3.5

--- a/src/Test/Tasty/Bench.hs
+++ b/src/Test/Tasty/Bench.hs
@ -27,7 +27,7 @@ machine is up to 16x faster than @criterion@ and up to 4x faster than
 GHC does, including WASM. We support a full range of architectures
 (@i386@, @amd64@, @armhf@, @arm64@, @ppc64le@, @s390x@) and operating
 systems (Linux, Windows, macOS, FreeBSD, OpenBSD, NetBSD), plus any GHC
-from 7.0 to 9.8.
+from 7.0 to 9.10.

 === How is it possible?

@ -1442,7 +1442,11 @@ ioToBench frc act = Benchmarkable go
 -- (by means of 'Control.DeepSeq.rnf', not 'Control.DeepSeq.force').
 --
 -- Pure subexpression of an effectful computation @x@
-- may be evaluated only once and get cached.
+-- may be evaluated only once and get cached. For example,
+-- GHC is likely to float @x@ out of 'nfIO' ('pure' @x@) and
+-- evaluate in only once, which leaves 'nfIO' to measure 'pure' only
+-- with results in nanosecond range.
+--
 -- To avoid surprising results it is usually preferable
 -- to use 'nfAppIO' instead.
 --
@ -1467,7 +1471,11 @@ nfIO = ioToBench rnf
 -- and compute its weak head normal form.
 --
 -- Pure subexpression of an effectful computation @x@
-- may be evaluated only once and get cached.
+-- may be evaluated only once and get cached. For example,
+-- GHC is likely to float @x@ out of 'whnfIO' ('pure' @x@) and
+-- evaluate in only once, which leaves 'whnfIO' to measure 'pure' only
+-- with results in nanosecond range.
+--
 -- To avoid surprising results it is usually preferable
 -- to use 'whnfAppIO' instead.
 --
--- a/tasty-bench.cabal
+++ b/tasty-bench.cabal
@ -25,7 +25,7 @@ extra-doc-files:
  example.svg
  README.md

-tested-with: GHC == 9.8.1, GHC == 9.6.3, GHC == 9.4.7, GHC == 9.2.8, GHC==9.0.2, GHC==8.10.7, GHC==8.8.4, GHC==8.6.5, GHC==8.4.4, GHC==8.2.2, GHC==8.0.2, GHC==7.10.3, GHC==7.8.4, GHC==7.6.3, GHC==7.4.2, GHC==7.2.2, GHC==7.0.4
+tested-with: GHC == 9.10.1, GHC == 9.8.2, GHC == 9.6.4, GHC == 9.4.8, GHC == 9.2.8, GHC==9.0.2, GHC==8.10.7, GHC==8.8.4, GHC==8.6.5, GHC==8.4.4, GHC==8.2.2, GHC==8.0.2, GHC==7.10.3, GHC==7.8.4, GHC==7.6.3, GHC==7.4.2, GHC==7.2.2, GHC==7.0.4

 source-repository head
  type: git
Author	SHA1	Message	Date
Bodigrim	5bd2d5064a	Regenerate CI	2024-03-16 23:12:09 +00:00
Bodigrim	2066ebb3a5	Elaborate documentation for nfIO / whnfIO	2024-03-16 22:56:42 +00:00