This action sets up a Haskell environment for use in actions by:
- optionally installing a version of ghc and cabal and adding to PATH.
- optionally installing a version of Stack and adding to PATH.
- setting the outputs of
ghc-path,cabal-path,stack-path, andcabal-storewhen necessary.
The GitHub runners come with pre-installed versions of GHC and Cabal. Those will be used whenever possible.
For all other versions, this action utilizes ppa:hvr/ghc, ghcup, and chocolatey.
See action.yml
Minimal:
on: [push]
name: build
jobs:
runhaskell:
name: Hello World
runs-on: ubuntu-latest # or macOS-latest, or windows-latest
steps:
- uses: actions/checkout@v2
- uses: actions/[email protected]
- run: runhaskell Hello.hsBasic:
on: [push]
name: build
jobs:
runhaskell:
name: Hello World
runs-on: ubuntu-latest # or macOS-latest, or windows-latest
steps:
- uses: actions/checkout@v2
- uses: actions/[email protected]
with:
ghc-version: '8.8' # Resolves to the latest point release of GHC 8.8
cabal-version: '3.0.0.0' # Exact version of Cabal
- run: runhaskell Hello.hsBasic with Stack:
on: [push]
name: build
jobs:
runhaskell:
name: Hello World
runs-on: ubuntu-latest # or macOS-latest, or windows-latest
steps:
- uses: actions/checkout@v2
- uses: actions/[email protected]
with:
ghc-version: '8.8.3' # Exact version of ghc to use
# cabal-version: 'latest'. Omitted, but defalts to 'latest'
enable-stack: true
stack-version: 'latest'
- run: runhaskell Hello.hsMatrix Testing:
on: [push]
name: build
jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
ghc: ['8.6.5', '8.8.3']
cabal: ['2.4.1.0', '3.0.0.0']
os: [ubuntu-latest, macOS-latest, windows-latest]
exclude:
# GHC 8.8+ only works with cabal v3+
- ghc: 8.8.3
cabal: 2.4.1.0
name: Haskell GHC ${{ matrix.ghc }} sample
steps:
- uses: actions/checkout@v2
- name: Setup Haskell
uses: actions/[email protected]
with:
ghc-version: ${{ matrix.ghc }}
cabal-version: ${{ matrix.cabal }}
- run: runhaskell Hello.hs| Name | Required | Description | Type | Default |
|---|---|---|---|---|
ghc-version |
GHC version to use, ex. latest |
string | latest | |
cabal-version |
Cabal version to use, ex. 3.2 |
string | latest | |
stack-version |
Stack version to use, ex. latest. Stack will only be installed if enable-stack is set. |
string | latest | |
enable-stack |
If specified, will setup Stack. | "boolean" | false | |
stack-no-global |
If specified, enable-stack must be set. Prevents installing GHC and Cabal globally | "boolean" | false | |
stack-setup-ghc |
If specified, enable-stack must be set. Runs stack setup to install the specified GHC. (Note: setting this does not imply stack-no-global) |
"boolean" | false |
| Name | Description | Type |
|---|---|---|
ghc-path |
The path of the ghc executable directory | string |
ghc-exe |
The path of the ghc executable | string |
cabal-path |
The path of the cabal executable directory | string |
cabal-exe |
The path of the cabal executable | string |
cabal-store |
The path to the cabal store | string |
stack-path |
The path of the stack executable directory | string |
stack-exe |
The path of the stack executable | string |
stack-root |
The path to the stack root | string |
GHC:
latest(default, recommended)8.10.28.108.10.18.8.48.88.8.38.8.28.8.18.6.58.68.6.48.6.38.6.28.6.18.4.48.48.4.38.4.28.4.18.2.28.28.0.28.07.10.37.10
Suggestion: Try to support the three latest major versions of GHC.
Cabal:
latest(default, recommended)3.2.0.03.23.0.0.03.02.4.1.02.42.4.0.02.2.0.02.2
Recommendation: Use the latest available version if possible.
Stack:
latest(recommended) -- follows the latest release automatically.2.3.32.32.3.12.1.32.12.1.11.9.3.11.91.9.1.11.7.11.71.6.51.61.6.3.11.6.1.11.5.11.51.5.01.4.01.41.3.21.31.3.01.2.01.2
Recommendation: Use the latest available version if possible.
The full list of available versions of GHC, Cabal, and Stack are as follows:
There are technically some descrepencies here. For example, "8.10.1-alpha1" will work for a ghc version for windows but not for Linux and macOS. For your sanity, I suggest sticking with the version lists above which are supported across all three operating systems.
versions.json exists an internal implementation detail because there's no nice way to otherwise suport short versions. If a version is not inside versions.json, the tool will happily attempt to use exactly what is specified.
This is to prevent versions.json from breaking any builds as it is, by design, an incomplete subset of possible versions.
The scripts and documentation in this project are released under the MIT License.
Contributions are welcome! See the Contributor's Guide.