CI: bump to latest Haskell-CI and GHC versions (9.6.0, 9.4.4, 9.2.5)

andreasabel · andreasabel · commit 01990bd367bc · 2023-02-08T20:10:56.000+01:00
Also:
- Restrict CI to PRs and dedicated branches (avoid duplicate CI runs).
- Describe in DEVELOPER.md how to update the CI.
diff --git a/.github/haskell-ci.patch b/.github/haskell-ci.patch
@@ -1,6 +1,6 @@
---- .github/workflows/haskell-ci.yml	2021-06-15 15:05:48.000000000 +0200
-+++ .github/workflows/haskell-ci.yml.patched	2021-06-15 15:05:35.000000000 +0200
-@@ -162,10 +162,23 @@
+--- .github/workflows/haskell-ci.yml	2023-02-08 20:09:03.000000000 +0100
++++ .github/workflows/haskell-ci.yml-patched	2023-02-08 20:08:57.000000000 +0100
+@@ -226,10 +226,23 @@
            rm -f cabal-plan.xz
            chmod a+x $HOME/.cabal/bin/cabal-plan
            cabal-plan --version
@@ -10,7 +10,7 @@
 +          $CABAL v2-install $ARG_COMPILER alex happy
 +
        - name: checkout
-         uses: actions/checkout@v2
+         uses: actions/checkout@v3
          with:
            path: source
 +
@@ -24,7 +24,7 @@
        - name: initial cabal.project for sdist
          run: |
            touch cabal.project
-@@ -208,15 +221,21 @@
+@@ -275,15 +288,21 @@
          run: |
            $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks --dependencies-only -j2 all
            $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH --dependencies-only -j2 all
diff --git a/.github/workflows/haskell-ci.yml b/.github/workflows/haskell-ci.yml
@@ -8,18 +8,26 @@
 #
 # For more information, see https://github.com/haskell-CI/haskell-ci
 #
-# version: 0.14.1
+# version: 0.15.20230203
 #
-# REGENDATA ("0.14.1",["github","alex.cabal"])
+# REGENDATA ("0.15.20230203",["github","alex.cabal"])
 #
 name: Haskell-CI
 on:
-  - push
-  - pull_request
+  push:
+    branches:
+      - master
+      - ci-*
+      - release-*
+  pull_request:
+    branches:
+      - master
+      - ci-*
+      - release-*
 jobs:
   linux:
     name: Haskell-CI - Linux - ${{ matrix.compiler }}
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     timeout-minutes:
       60
     container:
@@ -28,9 +36,19 @@ jobs:
     strategy:
       matrix:
         include:
-          - compiler: ghc-9.2.1
+          - compiler: ghc-9.6.0.20230128
             compilerKind: ghc
-            compilerVersion: 9.2.1
+            compilerVersion: 9.6.0.20230128
+            setup-method: ghcup
+            allow-failure: true
+          - compiler: ghc-9.4.4
+            compilerKind: ghc
+            compilerVersion: 9.4.4
+            setup-method: ghcup
+            allow-failure: false
+          - compiler: ghc-9.2.5
+            compilerKind: ghc
+            compilerVersion: 9.2.5
             setup-method: ghcup
             allow-failure: false
           - compiler: ghc-9.0.2
@@ -101,18 +119,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 }}
@@ -130,20 +150,20 @@ 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))')
           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 >= 90600)) -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:
@@ -172,6 +192,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
@@ -200,7 +232,7 @@ jobs:
           $CABAL v2-install $ARG_COMPILER alex happy
 
       - name: checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           path: source
 
@@ -236,15 +268,18 @@ 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 /^(alex)$/; }' >> cabal.project.local
           cat cabal.project
           cat cabal.project.local
       - name: dump install plan
         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
@@ -272,7 +307,16 @@ jobs:
         run: |
           cd ${PKGDIR_alex} || false
           ${CABAL} -vnormal check
+      - 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/DEVELOPER.md b/DEVELOPER.md
@@ -23,3 +23,39 @@ When new GHC versions become available, CI can be updated by
 This should work as long as `haskell-ci` does not change its generated
 workflow too much.  Otherwise, the patch might not apply cleanly and
 the workflow has to be patched manually.
+
+Updating to a new version of Haskell-CI
+---------------------------------------
+
+2023-02-08
+
+1. Install Haskell-CI from its source repo:
+
+        pushd /tmp
+        git clone https://github.com/haskell-CI/haskell-ci.git
+        cd haskell-ci
+        cabal install
+        popd
+
+2. Update the `tested-with` fields in the `.cabal` files.
+
+3. Follow the instructions to regenerate the Haskell CI workflow, which are:
+
+        haskell-ci regenerate
+        patch --input=.github/haskell-ci.patch .github/workflows/haskell-ci.yml
+
+If some hunks fail to apply in the last step, the patch as to be updated.
+
+4. Apply the remaining hunks manually.
+
+5. Save the patched workflow, regenerate the original workflow, regenerate the patch
+
+        cp .github/workflows/haskell-ci.yml .github/workflows/haskell-ci.yml-patched
+        haskell-ci regenerate
+        diff -u .github/workflows/haskell-ci.yml .github/workflows/haskell-ci.yml-patched > .github/haskell-ci.patch
+
+6. Now the patch will apply cleanly.
+
+        patch --input=.github/haskell-ci.patch .github/workflows/haskell-ci.yml
+
+7. Commit the updated files (no extra files need to be committed).
diff --git a/alex.cabal b/alex.cabal
@@ -7,7 +7,7 @@ license-file: LICENSE
 copyright: (c) Chis Dornan, Simon Marlow
 author: Chris Dornan and Simon Marlow
 maintainer: Simon Marlow <marlowsd@gmail.com>
-bug-reports: https://github.com/simonmar/alex/issues
+bug-reports: https://github.com/haskell/alex/issues
 stability: stable
 homepage: http://www.haskell.org/alex/
 synopsis: Alex is a tool for generating lexical analysers in Haskell
@@ -22,7 +22,9 @@ category: Development
 build-type: Simple
 
 tested-with:
-        GHC == 9.2.1
+        GHC == 9.6.0
+        GHC == 9.4.4
+        GHC == 9.2.5
         GHC == 9.0.2
         GHC == 8.10.7
         GHC == 8.8.4
@@ -93,7 +95,7 @@ extra-source-files:
 
 source-repository head
     type:     git
-    location: https://github.com/simonmar/alex.git
+    location: https://github.com/haskell/alex.git
 
 executable alex
   hs-source-dirs: src
diff --git a/cabal.haskell-ci b/cabal.haskell-ci
@@ -0,0 +1,5 @@
+branches: master ci-* release-*
+
+-- -- For bootstrapping:
+-- apt: alex happy
+-- alex in the distribution might be too old.
