Skip to content

Release tracking ticket template

This is the template to be used to create release tracking tickets. Copy this into a new issue and fill in the TODOs. Those items marked with major-only can be ignored for minor releases.

This is the release checklist for the TODO milestone. See #16816 (closed) for the template that this was derived from.

Pre-fork checklist (major-only)

When forking a new release branch for a new major release series (e.g. ghc-9.0), please check the following:

  • Add the release to the status page
  • Verify that haddock's development branch (namely the branch corresponding to GHC's previous major release, e.g. ghc-8.10) has been merged into ghc-head.
  • Verify that the platform support documentation is up-to-date with reality:
  • Remove the release notes for the previous release (e.g. docs/users_guide/8.6.*-notes.rst)
  • In configure.ac update MinBootGhcVersion to be the major version of the last supported bootstrap compiler. We currently guarantee bootstrapping with the last two major releases; therefore, when preparing, e.g., GHC 9.4 you should set MinBootGhcVersion to 9.0.
  • Create the new branch: git branch ghc-9.0
  • In the new branch bump the version number in configure.ac to, e.g., 9.0
  • In master bump the version number in configure.ac to that of the next development series, e.g., 9.1 and ensure that MinBootGhcVersion is set correctly
  • Verify that package versions have been bumped as necessary under PVP:
    • base
    • template-haskell
    • ghc-prim
  • Tag this master commit as, e.g., ghc-9.1-start
  • Push all of the above tags and branches
  • After forking remove release notes from master and start a new set of release notes for the next release

Pre-release checklist

  • Ensure that submodules are on released tags (the below is produced using this script):
    • libraries/Cabal: version todo
    • libraries/Win32: version todo
    • libraries/binary: version todo
    • libraries/bytestring: version todo
    • libraries/containers: version todo
    • libraries/deepseq: version todo
    • libraries/directory: version todo
    • libraries/filepath: version todo
    • libraries/haskeline: version todo
    • libraries/mtl: version todo
    • libraries/parsec: version todo
    • libraries/pretty: version todo
    • libraries/process: version todo
    • libraries/terminfo: version todo
    • libraries/text: version todo
    • libraries/time: version todo
    • libraries/transformers: version todo
    • libraries/unix: version todo
    • libraries/xhtml: version todo
    • utils/haddock: version todo
    • utils/hsc2hs: version todo
  • Notify stakeholders of release progress: Julian Ospald <hasufell@posteo.de>, ghc-devs@haskell.org
  • Non-released submodules up-to-date:
  • LlvmMinVersion and LlvmMaxVersion in configure.ac is targetting intended LLVM version
  • llvm-targets file updated
  • Release notes (docs/users_guide/x.y.z-notes.rst) written
    • Release notes linked in docs/users_guide/release-notes.rst
    • LLVM version requirement mentioned
    • Forward port changelogs from previous GHCs (#25049)
  • Remove "Included libraries" sections from old release notes
  • autoconf scripts updated
  • Update the Hadrian bootstrap metadata
  • Check that Unicode database in base (libraries/base/cbits/README.Unicode) reflects current standard release (http://www.unicode.org/versions/latest/).
  • Verify that the ~"backport needed" label has no more issues/merge requests needing backport
  • Verify that all CI builds are green before moving to release checklist
  • Update hadrian bootstrap plans for the latest compiler releases:
    • Update hadrian/bootstrap/generate_bootstrap_plans to include any new compiler releases in the last two major release series
    • Drop any plans that are outside of the bootstrap support window
    • Run hadrian/bootstrap/generate_bootstrap_plans and commit the files that it generates
    • Update bootstrap_matrix in .gitlab-ci.yml to reflect the most recent minor release in each major series supported by bootstrapping

Release checklist

  • Ensure that the Migration page is up-to-date
  • Push a provision provisional release commit to trigger the release builds using git push -o ci.variable="RELEASE_JOB=yes"
  • Wait until builds finish; verify that they finished successfully
  • Fetch release artifacts TODO: documentation
  • Write down a link to the release pipeline here:
  • Sign and push release artifacts to downloads.haskell.org [TODO: documentation]
  • Submit ghcup metadata upstream:
    • Manually trigger the ghcup-metadata-testing-release job of the release pipeline
    • Download the metadata_test.yaml artifact from the ghcup-metadata-release job of the release pipeline
    • Clone ghcup-metadata
    • Integrate the appropriate release section into ghcup-metadata/ghcup-0.0.7.yaml (or ghcup-prerelease-0.0.7.yaml for pre-releases)
    • Replace the &id<n> identifiers with unique names
    • Add the Latest (or LatestPrerelease) to the new release's viTags field
    • Remove Latest for the previous release's viTags field; for pre-releases add the Prerelease tag)
    • Add the base-w.x.y.z (e.g. base-4.19.0.0) tag to viTags
    • Sign the resulting metadata YAML file with gpg --detach-sign
    • Open a merge request submitting the metadata upstream
    • Start a "Bindist installation" workflow
  • Make a release tag
  • Release/revise GHC-maintained libraries on Hackage using this script:
    • libraries/base
    • libraries/ghc-prim
    • libraries/array
    • libraries/stm
    • libraries/ghc-heap
    • libraries/ghc-compact
    • libraries/ghc-boot
    • libraries/ghc-boot-th
    • libraries/hpc
    • libraries/libiserv
    • libraries/template-haskell
    • libraries/ghc-bignum
  • Update ghc/homepage>:
    • Write download page (see ghc/homepage>)
    • Make sure that the Signing Key is correct for the relevant release
    • Add news item to index.html
    • Add link to download.shtml. Be sure to link to the Migration guide.
    • Look over changes locally
    • Add release announcement to GHC blog. Be sure to link to the Migration guide.
    • Push changes to master
  • Announce on: GHC developers <ghc-devs@haskell.org>, GHC Users <glasgow-haskell-users@haskell.org>, Haskell Cafe <haskell-cafe@haskell.org>
    • Mention sponsors
    • Mention ghc/ghc-hq>
    • Link to release notes and migration guide
  • Announce on: Haskell Discourse, /r/haskell, /m/haskell
  • When releasing the latest version, update latest symlink on downloads.haskell.org, e.g. ln -sfT 9.6.3 latest if 9.6 was the latest major series.

Post-release checklist

Edited by sheaf
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information