GHC 9.8.1 tracking ticket
This is the release checklist for the %9.8.1 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:
-
Verify that haddock
's development branch (namely the branch corresponding to GHC's previous major release, e.g.ghc-8.10
) has been merged intoghc-head
. -
Remove the release notes for the previous release (e.g. docs/users_guide/8.6.*-notes.rst
) -
In configure.ac
updateMinBootGhcVersion
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 setMinBootGhcVersion
to9.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 inconfigure.ac
to that of the next development series, e.g.,9.1
and ensure thatMinBootGhcVersion
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
: todo (onCabal-v3.10.2.0+
) -
libraries/Win32
: version 2.13.4.0 -
libraries/array
: version 0.5.6.0 -
libraries/binary
: version 0.8.9.1 -
libraries/bytestring
: version 0.12.0.2 -
libraries/containers
: todo (onv0.6.7-15-gf61b0c91
) -
libraries/deepseq
: version 1.5.0.0 -
libraries/directory
: version 1.3.8.1 -
libraries/exceptions
: version 0.10.7 -
libraries/filepath
: version 1.4.100.4 -
libraries/haskeline
: version 0.8.2.1 -
libraries/mtl
: version 2.3.1 -
libraries/parsec
: version 3.1.17.0 -
libraries/pretty
: version 1.1.3.6 -
libraries/process
: version 1.6.18.0 -
libraries/semaphore-compat
: version 1.0.0 -
libraries/stm
: todo (onv2.5.1.0-10-gf8582bd
) -
libraries/terminfo
: version 0.4.1.6 -
libraries/text
: version 2.1 -
libraries/time
: version 1.12.2 -
libraries/transformers
: version 0.6.1.0 -
libraries/unix
: version 2.8.2.1 -
libraries/xhtml
: todo (on3000.2.2.1-7-g68353cc
) -
utils/haddock
: todo (onhaddock-2.28.0-release-77-g86d5fce5
) -
utils/hpc
: todo (onghc-9.4.1-alpha1-29-geb800fe
) -
utils/hsc2hs
: version 0.68.10
-
-
Notify stakeholders of release progress: Julian Ospald <hasufell@posteo.de>, ghc-devs@haskell.org
-
Non-released submodules up-to-date: -
nofib
(upstream: ghc/nofib>) -
libffi-tarballs
(upstream: ghc/libffi-tarballs>) -
libraries/ghc-bignum/gmp/gmp-tarballs
(upstream: ghc/gmp-tarballs>)
-
-
Release notes ( docs/users_guide/x.y.z-notes.rst
) written -
Release notes linked in docs/users_guide/release-notes.rst
-
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/). -
LlvmVersion
inconfigure.ac
is targetting intended LLVM version -
Release notes mentions LLVM version requirement -
llvm-targets
file updated -
Changelogs updated (these can be checked using .gitlab/linters/check-changelogs.sh
):-
libraries/ghc-prim
-
libraries/ghc-bignum
-
libraries/template-haskell
-
libraries/hpc
(upstream: ghc/hpc>) -
libraries/base
-
-
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
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:- Download the
metadata_test.yaml
artifact from theghcup-metadata-release
job of the release pipeline - Clone
ghcup-metadata
- Integrate the appropriate release section into
ghcup-metadata/ghcup-0.0.7.yaml
(orghcup-prerelease-0.0.7.yaml
for pre-releases) - Replace the
&id<n>
identifiers with unique names - Add the
Latest
(orLatestPrerelease
) to the new release'sviTags
field - Remove
Latest
for the previous release'sviTags
field; for pre-releases add thePrerelease
tag) - Add the
base-w.x.y.z
(e.g.base-4.19.0.0
) tag toviTags
- Open a merge request submitting the metadata upstream
- Download the
-
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>
-
Announce on: Haskell Discourse, /r/haskell, Twitter -
Update latest
symlink ondownloads.haskell.org
Post-release checklist
-
Update the Wiki status page -
Update the language pragma history -
Mark milestone as closed -
Update /topic
in#ghc
-
Update the VersionHistory wiki page -
Set RELEASE=NO
-
Create a release tracking ticket for the next release using the template in #16816 (closed)