Hackage documentation

See #125 for context.

Witch’s documentation is not available on Hackage. Their version of GHC is too old. It’s not clear when it will be upgraded.

It’s possible to build documentation in CI. That’s what this issue is for. Here’s what I’d like:

Generate documentation in CI as part of the normal build and test process.
Add documentation to the build artifact.
Upload documentation to Hackage when uploading new releases.

See also tfausak/haskell-packages#19 (comment).

Unfortunately this failed: https://github.com/tfausak/witch/actions/runs/15139967267/job/42561918707#step:6:5

Uploading documentation artifact/witch-1.3.0.2-docs.tar.gz...
Error: cabal: '/usr/bin/curl' exited with an error:
curl: (56) Illegal or missing hexadecimal sequence in chunked-encoding

I'm not sure if this is a transient error or not. Here is the generated documentation from that workflow run: witch-1.3.0.2-docs.tar.gz

As expected, re-running failed because it attempted to re-upload the package itself: https://github.com/tfausak/witch/actions/runs/15139967267/job/42565823558#step:5:12

This version of the package has already been uploaded.

Still failing, even on retry: https://github.com/tfausak/witch/actions/runs/15141971479/job/42570100636#step:4:8

Uploading documentation artifact/witch-1.3.0.3-docs.tar.gz...
Error: cabal: '/usr/bin/curl' exited with an error:
curl: (56) Illegal or missing hexadecimal sequence in chunked-encoding

Oh, this is a bug in Cabal: haskell/cabal#10920

It finally worked! 🎉 https://hackage.haskell.org/package/witch-1.3.0.4

But also apparently Hackage is now using GHC 9.8.4: https://hackage.haskell.org/package/witch-1.3.0.3/reports/1

Generate documentation and upload it to Hackage

Navigation Menu

Repository navigation

Hackage documentation #127

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Hackage documentation #127

Description

Activity

tfausak commented on May 20, 2025

tfausak commented on May 20, 2025

tfausak commented on May 20, 2025

tfausak commented on May 20, 2025

tfausak commented on May 20, 2025

tfausak commented on May 20, 2025

tfausak commented on May 20, 2025

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions