CI: Downgrade Cabal for GHC 8.10.7 (#2899) (#2902)

Cabal 3.14 silently ignores `haddock-options` in `cabal.project`. The
change is deliberate (though not warning about it probably is not). The
change is documented in some places:

https://github.com/haskell/cabal/blob/master/release-notes/cabal-install-3.14.0.0.md
https://github.com/haskell/cabal/blob/master/release-notes/WIP-Cabal-3.12.x.0.md
haskell/cabal#9177

(Note that the deprecation message apparently never made it to the
release notes)

We should probably think about how to fix this in the future, but for
now rolling back to Cabal 3.12 will allow us to build the documentation
as we want to again. The mentioned `haddock-version-cpp` flag in the
linked cabal PR 9177 above  to get a CPP define for
`__HADDOCK_VERSION__` did not work at all for me.

PR #2201 was supposed to update our Haddock generation to 9.0.2 but
accidentally picked 8.10.7 for the uploads to Hackage, which also fixed
issue #2200. I'm careful about upgrading Haddock now as I've experienced
several times now that there were undocumented changes going from one
version to the next that broke some rendering, and carefully rereading
our complete Haddock to scan for such breakage is an impossible task.
One day we'll have to upgrade, when we drop GHC 8.10 from Clash.

(cherry picked from commit 9d94353)

Co-authored-by: Peter Lebbing <[email protected]>

Author: mergify[bot]

.ci/docker/Dockerfile

@@ -111,7 +111,7 @@ RUN git clone https://github.com/verilator/verilator verilator \
 
 FROM builder AS build-ghc
 
-ARG ghcup_version="0.1.30.0"
+ARG ghcup_version="0.1.40.0"
 
 # Must be explicitly set
 ARG ghc_version

.ci/docker/build-and-publish-docker-image.sh

@@ -14,9 +14,9 @@ elif [[ "$1" != "" ]]; then
   exit 1
 fi
 
-UBUNTU_VERSION=jammy-20240911.1
+UBUNTU_VERSION=jammy-20250126
 GHC_VERSIONS=("9.10.1" "9.8.4" "9.6.6" "9.4.8" "9.2.8" "9.0.2" "8.10.7" "8.8.4" "8.6.5")
-CABAL_VERSION="3.14.1.0"
+CABAL_VERSIONS=("3.14.1.1" "3.14.1.1" "3.14.1.1" "3.14.1.1" "3.14.1.1" "3.14.1.1" "3.12.1.0" "3.14.1.1" "3.14.1.1")
 
 # We want to use docker buildkit so that our layers are built in parallel. This
 # is ignored completely on versions of docker which don't support buildkit.
@@ -25,6 +25,7 @@ export DOCKER_BUILDKIT=1
 for i in "${!GHC_VERSIONS[@]}"
 do
   GHC_VERSION="${GHC_VERSIONS[i]}"
+  CABAL_VERSION="${CABAL_VERSIONS[i]}"
 
   docker build \
     --build-arg UBUNTU_VERSION=${UBUNTU_VERSION} \

.ci/gitlab/benchmark.yml

@@ -1,5 +1,5 @@
 .benchmark:
-  image: ghcr.io/clash-lang/clash-ci:$GHC_VERSION-20250102
+  image: ghcr.io/clash-lang/clash-ci:$GHC_VERSION-20250306
   stage: test
   timeout: 2 hours
   variables:

.ci/gitlab/common.yml

@@ -8,13 +8,13 @@ default:
       - stuck_or_timeout_failure
 
 .common:
-  image: ghcr.io/clash-lang/clash-ci:$GHC_VERSION-20250102
+  image: ghcr.io/clash-lang/clash-ci:$GHC_VERSION-20250306
   timeout: 10 minutes
   stage: build
   variables:
     # Note that we copy+paste the image name into CACHE_FALLBACK_KEY. If we don't,
     # $GHC_VERSION gets inserted at verbatim, instead of resolving to some ghc version.
-    CACHE_FALLBACK_KEY: $CI_JOB_NAME-master-ghcr.io/clash-lang/clash-ci:$GHC_VERSION-20250102-3-3-non_protected
+    CACHE_FALLBACK_KEY: $CI_JOB_NAME-master-ghcr.io/clash-lang/clash-ci:$GHC_VERSION-20250306-3-3-non_protected
     GIT_SUBMODULE_STRATEGY: recursive
     TERM: xterm-color
   cache:

.github/workflows/ci.yml

@@ -139,7 +139,7 @@ jobs:
 
     # Run steps inside the clash CI docker image
     container:
-      image: ghcr.io/clash-lang/clash-ci:${{ matrix.ghc }}-20250102
+      image: ghcr.io/clash-lang/clash-ci:${{ matrix.ghc }}-20250306
 
       env:
         THREADS: 2

.gitlab-ci.yml

@@ -82,8 +82,6 @@ haddock:
   extends: .common-local
   needs: []
   stage: test
-  variables:
-    GHC_VERSION: 9.0.2
   artifacts:
     paths:
       - hadocs/*/*