purescript / docker-haskell

Build	Status	Badges	(per-arch)

---

Haskell Docker Official Images

This is the Git repo of the Docker "Official Image" for haskell. See the Docker Hub page for the full readme on how to use this Docker image.

Image Details

Included Tools

• Glasgow Haskell Compiler (GHC).
• Cabal the CLI tool.
• Haskell Stack the CLI tool.

Operating System Support

Operating System	Support	Supported Versions	Support Variants
Debian	Yes	buster	standard, slim
Alpine	Planned	Last 2 releases	N/A
Windows	Planned	ltsc2022	windowsservercore, nanoserver

Processor Architecture Support

• amd64
• aarch64 (does not include Stack)

Installation Method

Cabal + Stack

Cabal and Stack release binaries for various platforms. These are downloaded and made available eg. copied into /usr/local/bin.

GHC

GHC releases an archive which includes scripts to install GHC. Once downloaded GHC is installed via:

• ./configure (we pass in additional paramters to the configure step)
• make install

The installed binaries are made availabe on the PATH.

Verification Method

Verification is done following the 'preferred' method for docker official images. This means we:

• Verify the release is published by the expected person via PGP key verification.
• Verify the sha256 of the release is as expected.

Version Support Policy

GHC

GHC minor versions (eg. 9.2) that are either actively being maintained (new patch releases will come out) or are still popular will be supported by these images. Once both of these are no longer true, support can be dropped. Users can still pull these images, however they will not be listed on the docker hub page and will no longer be updated with new Cabal and Stack versions.

Additionally, only the latest patch version of each major version of GHC will recieve further updates.

Cabal + Stack

For actively supported GHC versions, Cabal and Stack should be updated when new versions are relesaed.

Maintenance

Building + Running Locally

You can build and run the images locally with something like:

$ docker build -t haskell-local 9.2/buster && docker run -it haskell-local bash

Updating The Images

Update Dockerfiles

When a new version of Cabal, Stack or GHC is released the images need to be updated. This involves:

1. Update to the new version in the Dockerfile.
2. Update the PGP key, if the person doing the release has changed.
3. Updating the sha256 to the new version of the tool, for all supported processor architectures.
4. For GHC: Updating the github actions to test the new version.

See an example of a GHC update.

Release New Versions

Images are built and released by the central docker official images system. Specifically haskell is maintained in this file. See the docs on this format.

1. Determine which docker haskell image GHC versions have been impacted by the unreleased changes.
2. Update the GitCommit in the haskell file.
3. Update the Tags if these have changed.
4. Create a PR, including info on what has changed. The official images people will review the actual Dockerfile changes as they want official images to maintain a high level of quality.
5. Once merged, their build system will run and the image updates will eventually be released.

This doc describes the process in more detail.

Update Docker Hub Docs

The docker hub haskell docs live in a separate repo.

Image Tests

Functionality Tests

The image tests live in the official-images repo. They are run against amd64 and aarch64 in this repo. When updating haskell in the official images repo they are only run against amd64.

Dockerfile Linting

This is done via hadolint. We should not be afraid to ignore hadolint rules globally if required as it is not really designed for the official images which have some nuances.