Skip to content

Fix build- and installation issues + bump GHC and dependencies (blocked by #14)#15

Merged
lazamar merged 3 commits intolazamar:mainfrom
carlwr:bump-and-freeze
Oct 1, 2025
Merged

Fix build- and installation issues + bump GHC and dependencies (blocked by #14)#15
lazamar merged 3 commits intolazamar:mainfrom
carlwr:bump-and-freeze

Conversation

@carlwr
Copy link
Copy Markdown
Contributor

@carlwr carlwr commented Sep 29, 2025

This PR stacks on top of #14. Diff for this PR only: carlwr/haskell-docs-cli@fix-win-CI-tests...bump-and-freeze
edit: commits for this PR rebased onto main after the merge of #14 into main (ffdbf90)

Fixes #8 and #13.


This great tool is currently a bit tricky to build/install - partly due to all dependency versions free-floating, partly due to an implicit system dependency on a dev version of zlib (the Github workers running the CI workflow have it, but the machines of many users would not).

This PR attempts to stabilize the situation and reduce future maintenance efforts. It makes the builds reproducible through the cabal.project.freeze file, which picks recently-versioned deps that are compatible with the GHC version that is also bumped to 9.12.2. The zlib package flags in cabal.config also removes the implicit system dependency and instead uses a bundled zlib regardless of platform.

I verified that CI still runs successfully, that a test release through the CI action still works, that cabal build/cabal install succeeds on a fresh clone (tested on macOS and Ubuntu), and that the updated project loads successfully in HLS.

The Haddock.hs edits refactor away use of head and tail since these cause compiler warnings with the updated GHC version. The refactored expressions should be functionally equivalent to the previous ones.

DEVELOPMENT.md is a pure suggestion - feel free to just skip it.

@carlwr
Copy link
Copy Markdown
Contributor Author

carlwr commented Oct 1, 2025

(I have rebased the commits of this PR onto main after the merge of #14.)

@lazamar
Copy link
Copy Markdown
Owner

lazamar commented Oct 1, 2025

Thank you so much for this!
It all looks great, but I'd like to ask to please remove the DEVELOPMENT.md file, I think it is mostly redundant.
If you try to cabal build and you don't have the ghc version the project expects you will get an error from Cabal telling you what to do, so the info in that file is not really needed.

Copy link
Copy Markdown
Owner

@lazamar lazamar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's just drop the DEVELOPMENT.md file please.

@carlwr
Copy link
Copy Markdown
Contributor Author

carlwr commented Oct 1, 2025

You're welcome!

No worries; I just pushed a replacement for the last commit that omits DEVELOPMENT.md.

@lazamar lazamar merged commit 6b58240 into lazamar:main Oct 1, 2025
3 checks passed
@carlwr carlwr deleted the bump-and-freeze branch October 18, 2025 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Installation fails while building warp-tls-3.3.6

2 participants