Skip to content
This repository was archived by the owner on Jan 5, 2024. It is now read-only.

Commit

Permalink
README: don't recommend 'latest' for 'ghc-version'
Browse files Browse the repository at this point in the history
The Haskell ecosystem might need some time to catch up after a GHC
release, so switching to the latest GHC early might break the build.

Users might still prefer 'latest', especially if CI runs seldom,
but we should not generally recommend it.
  • Loading branch information
andreasabel committed Mar 16, 2023
1 parent 6eacfdd commit f102749
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions setup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,8 +190,8 @@ jobs:
| Name | Description | Type | Default |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ----------- |
| `ghc-version` | GHC version to use, e.g. `9.2` or `9.2.4`. | `string` | `latest` |
| `cabal-version` | Cabal version to use, e.g. `3.4`. | `string` | `latest` |
| `ghc-version` | GHC version to use, e.g. `9.2` or `9.2.5`. | `string` | `latest` |
| `cabal-version` | Cabal version to use, e.g. `3.6`. | `string` | `latest` |
| `stack-version` | Stack version to use, e.g. `latest`. Stack will only be installed if `enable-stack` is set. | `string` | `latest` |
| `enable-stack` | If set, will setup Stack. | "boolean" | false/unset |
| `stack-no-global` | If set, `enable-stack` must be set. Prevents installing GHC and Cabal globally. | "boolean" | false/unset |
Expand Down Expand Up @@ -223,7 +223,7 @@ In contrast, a proper `boolean` input like `cabal-update` only accepts values `t

**GHC:**

- `latest` (default, recommended)
- `latest` (default)
- `9.6.1` `9.6`
- `9.4.4` `9.4`
- `9.4.3`
Expand Down Expand Up @@ -262,7 +262,7 @@ In contrast, a proper `boolean` input like `cabal-update` only accepts values `t
- `8.0.2` `8.0`
- `7.10.3` `7.10`

Suggestion: Try to support the three latest major versions of GHC.
Suggestion: Try to support at least the three latest major versions of GHC.

**Cabal:**

Expand All @@ -279,9 +279,9 @@ Suggestion: Try to support the three latest major versions of GHC.

Recommendation: Use the latest available version if possible.

**Stack:**
**Stack:** (with `enable-stack: true`)

- `latest` (recommended) -- follows the latest release automatically.
- `latest` (default, recommended)
- `2.9.3` `2.9`
- `2.9.1`
- `2.7.5` `2.7`
Expand Down

0 comments on commit f102749

Please sign in to comment.