Skip to content

Commit

Permalink
fix: adjust some wordings and versions in the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
Totto16 committed Dec 17, 2024
1 parent e6cbfc1 commit b11f282
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,16 @@ This is the Git repo of the [Docker "Official Image"](https://github.com/docker-

### Operating System Support

| Operating System | Support | Supported Versions | Support Variants |
|------------------|---------|--------------------|-------------------------------|
| Debian | Yes | buster | standard, slim |
| Alpine | [Planned](https://github.com/haskell/docker-haskell/issues/22) | Last 2 releases | N/A |
| Windows | [Planned](https://github.com/haskell/docker-haskell/issues/3) | ltsc2022 | windowsservercore, nanoserver |
| Operating System | Support | Supported Versions | Support Variants |
| ---------------- | -------------------------------------------------------------- | ------------------------------------------------- | ----------------------------- |
| Debian | Yes | buster, bullseye, bookworm (depending on version) | standard, slim |
| Alpine | [Planned](https://github.com/haskell/docker-haskell/issues/22) | Last 2 releases | N/A |
| Windows | [Planned](https://github.com/haskell/docker-haskell/issues/3) | ltsc2022 | windowsservercore, nanoserver |

### Processor Architecture Support

* amd64
* aarch64 ([does not include Stack](https://github.com/haskell/docker-haskell/issues/59))
* aarch64

### Installation Method

Expand Down Expand Up @@ -57,7 +57,7 @@ Verification is done following the ['preferred' method for docker official image

#### 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.
GHC minor versions (eg. 9.10) 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.

Expand All @@ -72,7 +72,7 @@ For actively supported GHC versions, Cabal and Stack should be updated when new
You can build and run the images locally with something like:

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

### Updating The Images
Expand All @@ -92,8 +92,8 @@ When a new version of Cabal, Stack or GHC is released the images need to be upda

##### GHC

1. Replace the old and new GHC version globally eg. `9.4.3` becomes `9.4.4`. This will update both Dockerfiles **and the github actions**.
2. Obtain the new sha256 for the new GHC binary distribution via https://downloads.haskell.org/~ghc/9.4.4/SHA256SUMS . Look for the sha for the `.tar.xz` supported versions (currently `x86_64-deb10` + `aarch64-deb10`).
1. Replace the old and new GHC version globally eg. `9.8.3` becomes `9.8.4`. This will update both Dockerfiles **and the github actions**.
2. Obtain the new sha256 for the new GHC binary distribution via https://downloads.haskell.org/~ghc/9.8.4/SHA256SUMS . Look for the sha for the `.tar.xz` supported versions (currently `x86_64-deb11` + `aarch64-deb11`).
3. Replace globally the old sha256 for these with the new one obtained in step 2.
4. Update the PGP key if the person doing the release has changed. You can build the image locally at this point to see if it works or not. If it fails you need to update the PGP key. You need to find the key from the person doing the release on the ubuntu keyserver. See below for known releasers.

Expand All @@ -105,8 +105,8 @@ An [example](https://github.com/haskell/docker-haskell/commit/d25abd175c94517494

##### Cabal

1. Replace the old and new cabal version globally eg. `3.6.2.0` becomes `3.8.1.0`.
2. Obtain the new sha256 for the new cabal binary distribution via https://downloads.haskell.org/~cabal/cabal-install-3.8.1.0/SHA256SUMS . Look for the sha for the `.tar.xz` supported versions (currently `x86_64-linux-deb10` + `aarch64-linux-deb10`).
1. Replace the old and new cabal version globally eg. `3.8.1.0` becomes `3.10.3.0`.
2. Obtain the new sha256 for the new cabal binary distribution via https://downloads.haskell.org/~cabal/cabal-install-3.10.3.0/SHA256SUMS . Look for the sha for the `.tar.xz` supported versions (currently `x86_64-linux-deb11` + `aarch64-linux-deb11`).
3. Replace globally the old sha256 for these with the new one obtained in step 2.
4. Update the PGP key if the person doing the release has changed. You can build the image locally at this point to see if it works or not. If it fails you need to update the PGP key. You need to find the key from the person doing the release on the ubuntu keyserver. See below for known releasers.

Expand Down

0 comments on commit b11f282

Please sign in to comment.