CI: Upgrade 8.10 to 8.10.7, Haddock to 9.0.2 #2201
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DigitalBrains1
force-pushed
the
upgrade-ghc-8.10
branch
2 times, most recently
from
943065d to
426cf3b
Compare
leonschoorl
added a commit
that referenced
this pull request
May 11, 2022
As seen in #2201, updates to the docker images can cause stuff in the cache to be broken. By putting the docker image into the cache key we always start clean whenever we update the docker images.
leonschoorl
force-pushed
the
upgrade-ghc-8.10
branch
from
4da7442 to
8d257d4
Compare
DigitalBrains1
pushed a commit
that referenced
this pull request
May 11, 2022
As seen in #2201, updates to the docker images can cause stuff in the cache to be broken. By putting the docker image into the cache key we always start clean whenever we update the docker images.
DigitalBrains1
force-pushed
the
upgrade-ghc-8.10
branch
from
8d257d4 to
e85e7a8
Compare
martijnbastiaan
requested changes
May 11, 2022
The haddock shipped with GHC 9 was generating warnings about not being able to link to `Tracked` and `Naming` because those types aren't being exported. But the docs making those references are on things which weren't exported either. The doc for the internal constructor `U` mistakenly referred to the no longer existing `unsafeToInteger`. Co-authored-by: Peter Lebbing <[email protected]>
As seen in #2201, updates to the docker images can cause stuff in the cache to be broken. By putting the docker image into the cache key we always start clean whenever we update the docker images. The `-3` is the cache bust suffix that gitlab automatically adds, except to the fallback key. See: https://docs.gitlab.com/ee/ci/caching/#clear-the-cache-manually https://docs.gitlab.com/ee/ci/caching/#cache-key-names
Now that the ghc package documentation is on Hackage for 8.10.7, we can upgrade our build version. Furthermore, we now build Haddock documentation for Hackage with 9.0.2 now. This fixes a Haddock bug we encountered: Fixes #2200
leonschoorl
force-pushed
the
upgrade-ghc-8.10
branch
from
e85e7a8 to
eb2d053
Compare
martijnbastiaan
approved these changes
May 13, 2022
DigitalBrains1
pushed a commit
that referenced
this pull request
May 30, 2022
As seen in #2201, updates to the docker images can cause stuff in the cache to be broken. By putting the docker image into the cache key we always start clean whenever we update the docker images. The `-3` is the cache bust suffix that gitlab automatically adds, except to the fallback key. See: https://docs.gitlab.com/ee/ci/caching/#clear-the-cache-manually https://docs.gitlab.com/ee/ci/caching/#cache-key-names
DigitalBrains1
added a commit
that referenced
this pull request
May 30, 2022
CI: Upgrade 8.10 to 8.10.7, Haddock to 9.0.2 (copy #2201)
1 task
DigitalBrains1
added a commit
that referenced
this pull request
Feb 14, 2023
The full tests that are run on the `1.6` branch accidentally refer to a non-existing docker image for 8.10: PR #2201 introduces 8.10.7 as the version for the docker image, but omitted the GHC version bump for the `build_and_test` target.
DigitalBrains1
added a commit
that referenced
this pull request
Feb 14, 2023
The full tests that are run on the `1.6` branch accidentally refer to a non-existing docker image for 8.10: PR #2201 introduces 8.10.7 as the version for the docker image, but omitted the GHC version bump for the `build_and_test` target.
DigitalBrains1
added a commit
that referenced
this pull request
Mar 5, 2025
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.
1 task
DigitalBrains1
added a commit
that referenced
this pull request
Mar 6, 2025
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.
mergify bot
pushed a commit
that referenced
this pull request
Mar 6, 2025
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) # Conflicts: # .ci/docker/build-and-publish-docker-image.sh # .ci/gitlab/benchmark.yml # .ci/gitlab/common.yml # .github/workflows/ci.yml
1 task
DigitalBrains1
added a commit
that referenced
this pull request
Mar 6, 2025
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)
DigitalBrains1
added a commit
that referenced
this pull request
Mar 6, 2025
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]>
DigitalBrains1
added a commit
that referenced
this pull request
Mar 7, 2025
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]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Now that the ghc package documentation is on Hackage for 8.10.7, we can
upgrade our build version.
Furthermore, we now build Haddock documentation for Hackage with 9.0.2
now.
This fixes a Haddock bug we encountered:
Fixes #2200
Still TODO:
Write a changelog entry (see changelog/README.md)