wiki:WorkingConventions/BootLibraries

Guidelines for boot library maintainers

Maintaining a GHC boot library is generally quite similar to any other well-maintained Haskell library. However, we do have a few specific requests,

  • Avoid non-fast-forward changes to tracked branches in the repository followed by GHC
  • Use annotated and signed tags for releases

Beyond this the interactions with GHC should be fairly minimal: we'll ask you before a release what version of your library you'd like for us to include (or request that you push a new release if necessary). It's of course appreciated if these requests are handled promptly as library issues can stall the release process.

Proposed release policy

The following is a proposed revision of our previous policy for synchronizing core libraries prior to GHC releases.

To ensure that GHC releases ship with up-to-date releases of core libraries, we follow this protocol for updating core libraries during the release process:

  1. When GHC cuts a feature-freeze branch, the release manager will ask the core library maintainers to cut a feature freeze branch of their libraries. Upon cutting the branch the maintainer should notify the release manager so the GHC submodule can be updated. It is expected that this take no longer than two weeks; if a library maintainer hasn't responded within two weeks GHC will ship with the library version shipped with the most recent GHC release.
  2. When GHC cuts a release candidate, the release manager will ask the core library maintainers to make a properly-tagged release of their branches.

Git tags

git push doesn't push tags by default, you have to push the tag explicitly via git push origin v1.2.3.4 or git push --tags (be careful though, the later command pushes *all* local tags)

For tagging the release in Git annotated Git tags shall be used. These are tags which contain a bit more metadata (e.g. creation date, tagger name, a tag message) than the "lightweight" tags created by git tag by default (see git-tag(1) for details). To create a annotated tag use the --annotate (-a) flag, e.g.

git tag -a -s v1.2.3.4

Note how here we also used the --sign (-s) flag, which requests that Git attach a GPG signature to the tag. It is highly recommended that GHC boot libraries use signed releases.

Like with git commit, the above command will drop you into a text editor to compose a "tag message". You may also use the usual -m flag to specify a message in the command-line.

Here's an example of a signed Git tag object.

Last modified 10 months ago Last modified on Feb 19, 2018 11:10:31 PM