My release process for Haskell libraries

Just a note to myself as to the steps I normally follow when releasing a Haskell library to Hackage.

Release steps

  1. Create a release-x.y branch
  2. Finalize ChangeLog.md
  3. Run nix-shell --run 'cabal haddock' and sanity check the haddocks
  4. Commit all changes, and push a release PR.
  5. Generated sdist using cabal sdist
  6. Upload a package candidate
  7. Sanity check the upload, and then “publish” it publicly.
  8. Run cabal haddock --haddock-for-hackage to generated haddocks for hackage.
  9. Run cabal upload -d --publish $PATH_TO_TARBALL to update haddocks on the release.
  10. Squash merge the PR.
  11. Draft a new release on Github. Copy paste the change log. This will automatically create and push the new git tag.

Post-release

  1. Increment cabal version in .cabal file
  2. Plan, as first task, updating of nixpkgs and package dependencies.

Open questions

  • Research a tool that automates much of the release process
logo