CI: Downgrade Cabal for GHC 8.10.7 (copy #2899) #2902
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Cabal 3.14 silently ignores
haddock-options
incabal.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.
Still TODO:
Write a changelog entry (see changelog/README.md)This is an automatic copy of pull request #2899 done by [Mergify](https://mergify.com).