agda-stdlib-utils: drop GHC < 8.6, modernise .cabal file, update CI (#1932)

andreasabel · web-flow · commit 46daf81a51a6 · 2023-02-23T09:51:00.000+09:00
With Agda-2.6.4 dropping GHC &lt; 8.6, we can follow suit here.
This encourages us to also bump the `cabal-version`,
which allows us to modernise the `.cabal` file.

Update the Haskell-CI to the latest versions.
Also insert some `paths` triggers via the patching mechanism,
so that this workflow does not run on the usual PRs that
just contribute to the Agda code in the library.
diff --git a/.github/haskell-ci.patch b/.github/haskell-ci.patch
@@ -1,19 +1,23 @@
---- workflows/haskell-ci.yml	2022-01-31 17:55:16.000000000 +0100
-+++ workflows/haskell-ci.yml-patched	2022-01-31 17:59:20.000000000 +0100
-@@ -14,8 +14,14 @@
- #
- name: Haskell-CI
- on:
--  - push
--  - pull_request
-+  push:
-+    branches:
-+      - master
-+      - experimental
-+  pull_request:
-+    branches:
-+      - master
-+      - experimental
+--- .github/workflows/haskell-ci.yml	2023-02-22 18:05:26.000000000 +0100
++++ .github/workflows/haskell-ci.yml-patched	2023-02-22 18:04:31.000000000 +0100
+@@ -18,10 +18,20 @@
+     branches:
+       - master
+       - experimental
++    paths:
++      - .github/workflows/haskell-ci.yml
++      - agda-stdlib-utils.cabal
++      - cabal.haskell-ci
++      - *.hs
+   pull_request:
+     branches:
+       - master
+       - experimental
++    paths:
++      - .github/workflows/haskell-ci.yml
++      - agda-stdlib-utils.cabal
++      - cabal.haskell-ci
++      - *.hs
  jobs:
    linux:
      name: Haskell-CI - Linux - ${{ matrix.compiler }}
diff --git 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.14
+# version: 0.15.20230217
 #
-# REGENDATA ("0.14",["github","--no-cabal-check","agda-stdlib-utils.cabal"])
+# REGENDATA ("0.15.20230217",["github","--no-cabal-check","agda-stdlib-utils.cabal"])
 #
 name: Haskell-CI
 on:
@@ -25,7 +25,7 @@ on:
 jobs:
   linux:
     name: Haskell-CI - Linux - ${{ matrix.compiler }}
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     timeout-minutes:
       60
     container:
@@ -34,9 +34,14 @@ jobs:
     strategy:
       matrix:
         include:
-          - compiler: ghc-9.2.1
+          - compiler: ghc-9.4.4
             compilerKind: ghc
-            compilerVersion: 9.2.1
+            compilerVersion: 9.4.4
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-9.2.6
+            compilerKind: ghc
+            compilerVersion: 9.2.6
             setup-method: ghcup
             allow-failure: false
           - compiler: ghc-9.0.2
@@ -59,21 +64,6 @@ jobs:
             compilerVersion: 8.6.5
             setup-method: hvr-ppa
             allow-failure: false
-          - compiler: ghc-8.4.4
-            compilerKind: ghc
-            compilerVersion: 8.4.4
-            setup-method: hvr-ppa
-            allow-failure: false
-          - compiler: ghc-8.2.2
-            compilerKind: ghc
-            compilerVersion: 8.2.2
-            setup-method: hvr-ppa
-            allow-failure: false
-          - compiler: ghc-8.0.2
-            compilerKind: ghc
-            compilerVersion: 8.0.2
-            setup-method: hvr-ppa
-            allow-failure: false
       fail-fast: false
     steps:
       - name: apt
@@ -82,18 +72,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.17.3/x86_64-linux-ghcup-0.1.17.3 > "$HOME/.ghcup/bin/ghcup"
+            curl -sL https://downloads.haskell.org/ghcup/0.1.18.0/x86_64-linux-ghcup-0.1.18.0 > "$HOME/.ghcup/bin/ghcup"
             chmod a+x "$HOME/.ghcup/bin/ghcup"
-            "$HOME/.ghcup/bin/ghcup" install ghc "$HCVER"
-            "$HOME/.ghcup/bin/ghcup" install cabal 3.6.2.0
+            "$HOME/.ghcup/bin/ghcup" config add-release-channel https://raw.githubusercontent.com/haskell/ghcup-metadata/master/ghcup-prereleases-0.0.7.yaml;
+            "$HOME/.ghcup/bin/ghcup" install ghc "$HCVER" || (cat "$HOME"/.ghcup/logs/*.* && false)
+            "$HOME/.ghcup/bin/ghcup" install cabal 3.9.0.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.17.3/x86_64-linux-ghcup-0.1.17.3 > "$HOME/.ghcup/bin/ghcup"
+            curl -sL https://downloads.haskell.org/ghcup/0.1.18.0/x86_64-linux-ghcup-0.1.18.0 > "$HOME/.ghcup/bin/ghcup"
             chmod a+x "$HOME/.ghcup/bin/ghcup"
-            "$HOME/.ghcup/bin/ghcup" install cabal 3.6.2.0
+            "$HOME/.ghcup/bin/ghcup" config add-release-channel https://raw.githubusercontent.com/haskell/ghcup-metadata/master/ghcup-prereleases-0.0.7.yaml;
+            "$HOME/.ghcup/bin/ghcup" install cabal 3.9.0.0 || (cat "$HOME"/.ghcup/logs/*.* && false)
           fi
         env:
           HCKIND: ${{ matrix.compilerKind }}
@@ -111,13 +103,13 @@ jobs:
             echo "HC=$HC" >> "$GITHUB_ENV"
             echo "HCPKG=$HOME/.ghcup/bin/$HCKIND-pkg-$HCVER" >> "$GITHUB_ENV"
             echo "HADDOCK=$HOME/.ghcup/bin/haddock-$HCVER" >> "$GITHUB_ENV"
-            echo "CABAL=$HOME/.ghcup/bin/cabal-3.6.2.0 -vnormal+nowrap" >> "$GITHUB_ENV"
+            echo "CABAL=$HOME/.ghcup/bin/cabal-3.9.0.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.6.2.0 -vnormal+nowrap" >> "$GITHUB_ENV"
+            echo "CABAL=$HOME/.ghcup/bin/cabal-3.9.0.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))')
@@ -176,7 +168,7 @@ jobs:
           chmod a+x $HOME/.cabal/bin/cabal-plan
           cabal-plan --version
       - name: checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           path: source
       - name: initial cabal.project for sdist
@@ -200,8 +192,8 @@ jobs:
           touch cabal.project
           touch cabal.project.local
           echo "packages: ${PKGDIR_agda_stdlib_utils}" >> cabal.project
-          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "package agda-stdlib-utils" >> cabal.project ; fi
-          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "    ghc-options: -Werror=missing-methods" >> cabal.project ; fi
+          echo "package agda-stdlib-utils" >> cabal.project
+          echo "    ghc-options: -Werror=missing-methods" >> cabal.project
           cat >> cabal.project <<EOF
           EOF
           $HCPKG list --simple-output --names-only | perl -ne 'for (split /\s+/) { print "constraints: $_ installed\n" unless /^(agda-stdlib-utils)$/; }' >> cabal.project.local
@@ -211,8 +203,8 @@ jobs:
         run: |
           $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH --dry-run all
           cabal-plan
-      - name: cache
-        uses: actions/cache@v2
+      - name: restore cache
+        uses: actions/cache/restore@v3
         with:
           key: ${{ runner.os }}-${{ matrix.compiler }}-${{ github.sha }}
           path: ~/.cabal/store
@@ -227,7 +219,16 @@ jobs:
       - name: build
         run: |
           $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH all --write-ghc-environment-files=always
+      - name: haddock
+        run: |
+          $CABAL v2-haddock --disable-documentation --haddock-all $ARG_COMPILER --with-haddock $HADDOCK $ARG_TESTS $ARG_BENCH all
       - name: unconstrained build
         run: |
           rm -f cabal.project.local
           $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks all
+      - name: save cache
+        uses: actions/cache/save@v3
+        if: always()
+        with:
+          key: ${{ runner.os }}-${{ matrix.compiler }}-${{ github.sha }}
+          path: ~/.cabal/store
diff --git a/HACKING.md b/HACKING.md
@@ -267,14 +267,16 @@ Continuous Integration (CI)
 Updating the Haskell-CI workflow
 --------------------------------
 
-The file `.github/workflows/haskell-ci.yml` is autogenerated by the
-tool `haskell-ci` but has some custom modification which need to be
-restored after each regeneration of this workflow.
+The file `.github/workflows/haskell-ci.yml` tests building the helpers specified in `agda-stdlib-utils.cabal`.
+It is autogenerated by the tool [haskell-ci]
+but has some custom modification which need to be restored after each regeneration of this workflow.
 
-`haskell-ci` creates the workflow file from the contents of the
-`tested-with` field in the `agda-stdlib-utils.cabal` file.  After
-updating this field, run the following:
+[haskell-ci] creates the workflow file from settings in the `cabal.haskell-ci` file
+and from the contents of the `tested-with` field in the `agda-stdlib-utils.cabal` file.
+After updating this field, run the following:
 ```
 haskell-ci regenerate
 patch --input=.github/haskell-ci.patch .github/workflows/haskell-ci.yml
 ```
+
+[haskell-ci]: https://github.com/haskell-CI/haskell-ci
diff --git a/agda-stdlib-utils.cabal b/agda-stdlib-utils.cabal
@@ -1,34 +1,43 @@
+cabal-version:   2.4
 name:            agda-stdlib-utils
-version:         2.0-dev
-cabal-version:   >= 1.10
+version:         2.0
 build-type:      Simple
-description:     Helper programs.
+description:     Helper programs for setting up the Agda standard library.
 license:         MIT
-tested-with:     GHC == 8.0.2
-                 GHC == 8.2.2
-                 GHC == 8.4.4
-                 GHC == 8.6.5
-                 GHC == 8.8.4
-                 GHC == 8.10.7
-                 GHC == 9.0.2
-                 GHC == 9.2.1
-                 GHC == 9.4.4
+
+tested-with:
+  GHC == 9.4.4
+  GHC == 9.2.6
+  GHC == 9.0.2
+  GHC == 8.10.7
+  GHC == 8.8.4
+  GHC == 8.6.5
+
+common common-build-parameters
+  default-language:
+    Haskell2010
+  default-extensions:
+    PatternGuards
+    PatternSynonyms
+
+  build-depends:
+      base          >= 4.12.0.0 && < 4.18
+    , filemanip     >= 0.3.6.2  && < 0.4
 
 executable GenerateEverything
+  import:           common-build-parameters
   hs-source-dirs:   .
   main-is:          GenerateEverything.hs
-  default-language: Haskell2010
-  default-extensions: PatternGuards, PatternSynonyms
-  build-depends:      base      >= 4.9.0.0 && < 4.18
-                    , directory >= 1.0.0.0 && < 1.4
-                    , filemanip >= 0.3.6.2 && < 0.4
-                    , filepath  >= 1.4.1.0 && < 1.5
-                    , mtl       >= 2.2.2   && < 2.4
+
+  build-depends:
+      directory     >= 1.0.0.0  && < 1.4
+    , filepath      >= 1.4.1.0  && < 1.5
+    , mtl           >= 2.2.2    && < 2.4
 
 executable AllNonAsciiChars
+  import:           common-build-parameters
   hs-source-dirs:   .
   main-is:          AllNonAsciiChars.hs
-  default-language: Haskell2010
-  build-depends:      base      >= 4.9.0.0 && < 4.18
-                    , filemanip >= 0.3.6.2 && < 0.4
-                    , text      >= 1.2.3.0 && < 2.1
+
+  build-depends:
+      text          >= 1.2.3.1  && < 2.1
diff --git a/cabal.haskell-ci b/cabal.haskell-ci
@@ -0,0 +1,3 @@
+branches: master experimental
+haddock-components: all
+cabal-check: False

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+branches: master experimental`
	`2`	`+haddock-components: all`
	`3`	`+cabal-check: False`