hackage-release
Hackage Release
Bump version, build, validate, tag, push, and publish a Haskell package to Hackage.
Workflow
- Bump version in
package.yaml(if using hpack) or.cabalfile - Update ChangeLog.md with release notes
- Regenerate cabal (if using hpack):
hpack - Build:
cabal build - Check:
cabal check(must report zero warnings) - Create sdist:
cabal sdist - Commit & tag: commit all changed files,
git tag vX.Y.Z.W - Push:
git push && git push --tags - Get Hackage credentials:
pass show hackage.haskell.org.gpg- Format: first line is password,
user:line has username
- Format: first line is password,
- Publish package:
cabal upload --publish <sdist-tarball> --username=<user> --password='<pass>' - Build & publish docs:
cabal haddock --haddock-for-hackagethencabal upload --documentation --publish <docs-tarball> --username=<user> --password='<pass>'
Version Bumping (PVP)
Haskell uses the Package Versioning Policy with format A.B.C.D:
| Component | When to Bump |
|---|---|
| A.B (major) | Breaking API changes |
| C (minor) | Backwards-compatible new features |
| D (patch) | Bug fixes, non-API changes |
Nix-Based Projects
If the project uses a Nix flake, wrap cabal commands with nix develop:
nix develop --command cabal build
nix develop --command cabal check
nix develop --command hpack package.yaml
Prefer nix develop (flake) over nix-shell (legacy) to avoid ABI mismatches.
PVP Dependency Bounds
Hackage warns about:
- Missing upper bounds: Every dependency should have an upper bound (e.g.,
text >= 1.2 && < 2.2) - Trailing zeros in upper bounds: Use
< 2not< 2.0.0; use< 0.4not< 0.4.0.0
Run cabal check to verify zero warnings before releasing.
Checklist
- Version bumped in package.yaml / .cabal
- ChangeLog.md updated
- Cabal file regenerated (if hpack)
-
cabal buildsucceeds -
cabal checkreports no errors or warnings - Changes committed and tagged
- Pushed to remote with tags
- Package published to Hackage
- Docs published to Hackage
More from colonelpanic8/dotfiles
email-unsubscribe-check
Use when user wants to find promotional or unwanted recurring emails to unsubscribe from, or when doing periodic inbox hygiene to identify senders worth unsubscribing from
19release
Use when user asks to release, publish, bump version, or prepare a new version for deployment
1slides
Build, edit, render, import, and export presentation decks with the preloaded @oai/artifact-tool JavaScript surface through the artifacts tool.
1spreadsheets
Build, edit, recalculate, import, and export spreadsheet workbooks with the preloaded @oai/artifact-tool JavaScript surface through the artifacts tool.
1org-agenda-api
Use when interacting with the org-agenda-api HTTP server to read/write org-mode agenda data
1playwright-cli
Automate browser interactions from the shell using Playwright via the `playwright-cli` command (open/goto/snapshot/click/type/screenshot, tabs/storage/network). Use when you need deterministic browser automation for web testing, form filling, screenshots/PDFs, or data extraction.
1