This action sets up a Haskell environment for use in actions by:
- if requested, installing a version of ghc and cabal and adding them to
PATH, - if requested, installing a version of Stack and adding it to the
PATH, - outputting of
ghc-version/exe/path,cabal-version/exe/path,stack-version/exe/path,stack-rootandcabal-store(for the requested components).
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
on: [push]
name: build
jobs:
runhaskell:
name: Hello World
runs-on: ubuntu-latest # or macOS-latest, or windows-latest
steps:
- uses: actions/checkout@v4
- uses: haskell-actions/setup@v2
- run: runhaskell Hello.hson: [push]
name: build
jobs:
runhaskell:
name: Hello World
runs-on: ubuntu-latest # or macOS-latest, or windows-latest
steps:
- uses: actions/checkout@v4
- uses: haskell-actions/setup@v2
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.hson: [push]
name: build
jobs:
runhaskell:
name: Hello World
runs-on: ubuntu-latest # or macOS-latest, or windows-latest
steps:
- uses: actions/checkout@v4
- uses: haskell-actions/setup@v2
with:
ghc-version: '8.8.4' # Exact version of ghc to use
# cabal-version: 'latest'. Omitted, but defaults to 'latest'
enable-stack: true
stack-version: 'latest'
- run: runhaskell Hello.hson: [push]
name: build
jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
ghc: ['8.6.5', '8.8.4']
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.4
cabal: 2.4.1.0
name: Haskell GHC ${{ matrix.ghc }} sample
steps:
- uses: actions/checkout@v4
- name: Setup Haskell
uses: haskell-actions/setup@v2
with:
ghc-version: ${{ matrix.ghc }}
cabal-version: ${{ matrix.cabal }}
- run: runhaskell Hello.hsname: build
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]
# INFO: The following configuration block ensures that only one build runs per branch,
# which may be desirable for projects with a costly build process.
# Remove this block from the CI workflow to let each CI job run to completion.
concurrency:
group: build-${{ github.ref }}
cancel-in-progress: true
jobs:
build:
name: GHC ${{ matrix.ghc-version }} on ${{ matrix.os }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest]
ghc-version: ['9.8', '9.6', '9.4', '9.2', '9.0']
include:
- os: windows-latest
ghc-version: '9.8'
- os: macos-latest
ghc-version: '9.8'
steps:
- uses: actions/checkout@v4
- name: Set up GHC ${{ matrix.ghc-version }}
uses: haskell-actions/setup@v2
id: setup
with:
ghc-version: ${{ matrix.ghc-version }}
# Defaults, added for clarity:
cabal-version: 'latest'
cabal-update: true
- name: Configure the build
run: |
cabal configure --enable-tests --enable-benchmarks --disable-documentation
cabal build all --dry-run
# The last step generates dist-newstyle/cache/plan.json for the cache key.
- name: Restore cached dependencies
uses: actions/cache/restore@v4
id: cache
env:
key: ${{ runner.os }}-ghc-${{ steps.setup.outputs.ghc-version }}-cabal-${{ steps.setup.outputs.cabal-version }}
with:
path: ${{ steps.setup.outputs.cabal-store }}
key: ${{ env.key }}-plan-${{ hashFiles('**/plan.json') }}
restore-keys: ${{ env.key }}-
- name: Install dependencies
# If we had an exact cache hit, the dependencies will be up to date.
if: steps.cache.outputs.cache-hit != 'true'
run: cabal build all --only-dependencies
# Cache dependencies already here, so that we do not have to rebuild them should the subsequent steps fail.
- name: Save cached dependencies
uses: actions/cache/save@v4
# If we had an exact cache hit, trying to save the cache would error because of key clash.
if: steps.cache.outputs.cache-hit != 'true'
with:
path: ${{ steps.setup.outputs.cabal-store }}
key: ${{ steps.cache.outputs.cache-primary-key }}
- name: Build
run: cabal build all
- name: Run tests
run: cabal test all
- name: Check cabal file
run: cabal check
- name: Build documentation
run: cabal haddock all| Name | Description | Type | Default |
|---|---|---|---|
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 |
stack-setup-ghc |
If set, enable-stack must be set. Runs stack setup to install the specified GHC. (Note: setting this does not imply stack-no-global.) |
"boolean" | false/unset |
disable-matcher |
If set, disables match messages from GHC as GitHub CI annotations. | "boolean" | false/unset |
cabal-update |
If set to false, skip cabal update step. |
boolean |
true |
ghcup-release-channel |
If set, add a release channel to ghcup. | URL |
none |
Note: "boolean" types are set/unset, not true/false.
That is, setting any "boolean" to a value other than the empty string ("") will be considered true/set.
However, to avoid confusion and for forward compatibility, it is still recommended to only use value true to set a "boolean" flag.
In contrast, a proper boolean input like cabal-update only accepts values true and false.
The action outputs parameters for the components it installed.
E.g. if ghc-version: 8.10 is requested, the action will output ghc-version: 8.10.7 if installation succeeded,
and ghc-exe and ghc-path will be set accordingly.
(Details on version resolution see next section.)
| Name | Description | Type |
|---|---|---|
ghc-version |
The resolved version of ghc |
string |
cabal-version |
The resolved version of cabal |
string |
stack-version |
The resolved version of stack |
string |
ghc-exe |
The path of the ghc executable |
string |
cabal-exe |
The path of the cabal executable |
string |
stack-exe |
The path of the stack executable |
string |
ghc-path |
The path of the ghc executable directory |
string |
cabal-path |
The path of the cabal executable directory |
string |
stack-path |
The path of the stack executable directory |
string |
cabal-store |
The path to the cabal store | string |
stack-root |
The path to the stack root (equal to the STACK_ROOT environment variable if it is set; otherwise an OS-specific default) |
string |
This action is conscious about the tool versions specified in versions.json.
This list is replicated (hopefully correctly) below.
Versions specified by the inputs, e.g. ghc-version, are resolved against this list,
by taking the first entry from the list if latest is requested,
or the first entry that matches exactly,
or otherwise the first entry that is a (string-)extension of the requested version extended by a ..
E.g., 8.10 will be resolved to 8.10.7, and so will 8.
GHC:
latest-nightly(requires the resp.ghcup-release-channel, e.g.https://ghc.gitlab.haskell.org/ghcup-metadata/ghcup-nightlies-0.0.7.yaml)latest(default)9.8.29.89.8.19.6.59.69.6.49.6.39.6.29.6.19.4.89.49.4.79.4.69.4.59.4.49.4.39.4.29.4.19.2.89.29.2.79.2.69.2.59.2.49.2.39.2.29.2.19.0.29.09.0.18.10.78.108.10.68.10.58.10.48.10.38.10.28.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(not onubuntu-22.04or up)
Suggestion: Try to support at least the three latest major versions of GHC.
Cabal:
head(the cabal-head release of the most recent build of themasterbranch)latest(default, recommended)3.10.3.03.103.10.2.13.10.2.03.10.1.03.8.1.03.83.6.2.03.63.6.0.03.4.1.03.43.4.0.03.2.0.03.23.0.0.03.02.4.1.02.4
Recommendation: Use the latest available version if possible.
Stack: (with enable-stack: true)
latest(default, recommended)2.15.52.152.15.32.15.12.13.12.132.11.12.112.9.32.92.9.12.7.52.72.7.32.7.12.5.12.52.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.
Beyond the officially supported listed versions above, you can request any precise version of GHC, Cabal, and Stack. The action will forward the request to the install methods (apt, ghcup, choco), and installation might succeed.
Note however that Chocolatey's version numbers might differ from the official ones, please consult their pages for GHC and Cabal.
The scripts and documentation in this project are released under the MIT License.
Contributions are welcome! See the Contributor's Guide.