actions/setup-haskell
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add Windows and macOS Support (#1)

Browse Source 
* Re-base onto upstream master

* Use os over operating-system per json schema suggestion

* Upgrade dependencies

* Update action.yml syntax

* Restructure repo on latest typescript-action

* Update workflow.yml to use same node version as action.yml

* Pull in improvements from open PRs. Fix package.json scripts

* Type function return arguments

* Don't eslint automatic formatting changes

* Initial implementation of ghc+cabal install for linux/mac/windows

* Update README

* Fix cabal version in action.yml

* Implement initial simplistic test suite

* Test action with CI

* Use chocolatey directly to install ghc and cabal

* Try pre-installed tool on linux first

* Clean up documentation

* Expand README

* Test super old GHC on ubuntu

* Implement support for stack

* Update documentation about Stack support

* Test stack install in Github Actions CI

authored-by: Jared Weakly <jweakly@galois.com>
This commit is contained in:
jared-w
2020-03-23 11:18:29 -07:00
committed by Jared Weakly
parent a6006d2c28
commit 8154472447
195 changed files with 12947 additions and 15942 deletions
Download Patch File Download Diff File Expand all files Collapse all files

141
README.md
View File

@@ -1,12 +1,11 @@
# setup-haskell
<p align="left">
<a href="https://github.com/actions/setup-haskell"><img alt="GitHub Actions status" src="https://github.com/actions/setup-haskell/workflows/Main%20workflow/badge.svg"></a>
</p>
[![GitHub Actions status](https://github.com/actions/setup-haskell/workflows/Main%20workflow/badge.svg)](https://github.com/actions/setup-haskell)
This action sets up a Haskell environment for use in actions by:
This action installs a specified version of GHC and Cabal. It can also install [Stack](https://haskellstack.org).
- optionally installing a version of ghc and cabal and adding to PATH. Note that this action only uses versions of ghc and cabal already installed in the cache. The action will fail if no matching versions are found.
Currently only Linux comes with [pre-installed versions of GHC and Cabal](https://github.com/actions/virtual-environments/blob/master/images/linux/Ubuntu1804-README.md). Those will be used whenever possible.
For all other versions and for Windows and macOS, this action utilizes [`ghcup`](https://gitlab.haskell.com/ghcup) and [`chocolatey`](https://chocolatey.org/packages/ghc).
## Usage
@@ -14,26 +13,58 @@ See [action.yml](action.yml)
Basic:
``` yaml
steps:
- uses: actions/checkout@v2
- uses: actions/setup-haskell@v1
with:
ghc-version: '8.6.5' # Exact version of ghc to use
cabal-version: '3.0'
- run: runghc Hello.hs
```yaml
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/setup-haskell@v1
with:
ghc-version: '8.8.3' # Exact version of ghc to use
cabal-version: '3.0.0.0'
- run: runhaskell Hello.hs
```
Basic with Stack:
```yaml
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/setup-haskell@v1
with:
ghc-version: '8.8.3' # Exact version of ghc to use
cabal-version: '3.0.0.0'
stack-version: 'latest'
- run: runhaskell Hello.hs
```
Matrix Testing:
``` yaml
```yaml
on: [push]
name: build
jobs:
build:
runs-on: ubuntu-16.04
runs-on: ${{ matrix.os }}
strategy:
matrix:
ghc: [ '8.2.2', '8.6.5' ]
cabal: [ '2.0', '3.0' ]
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
@@ -42,26 +73,72 @@ jobs:
with:
ghc-version: ${{ matrix.ghc }}
cabal-version: ${{ matrix.cabal }}
- run: runghc Hello.hs
- run: runhaskell Hello.hs
```
Supported versions of GHC:
## Inputs
- `8.0.2`
- `8.2.2`
- `8.4.4`
- `8.6.2`
- `8.6.3`
- `8.6.4`
- `8.6.5`
| Name | Required | Description | Type | Default |
| ----------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------- |
| `ghc-version` | | GHC version to use, ex. `8.8.3` | string | 8.8.3 |
| `cabal-version` | | Cabal version to use, ex. `3.0.0.0` | string | 3.0.0.0 |
| `stack-version` | | Stack version to use, ex. `latest`. Stack will only be installed if this option is set | string | |
| `stack-no-global` | | If specified, stack-version must be set. Prevents installing GHC and Cabal globally | "boolean" | |
| `stack-setup-ghc` | | If specified, stack-version must be set. Runs stack setup to install the specified GHC. (Note: setting this does _not_ imply `stack-no-global`) | "boolean" | 3.0.0.0 |
## Version Support
**GHC:**
- `8.8.3` (default)
- `8.8.2`
- `8.8.1`
- `8.6.5`
- `8.6.4`
- `8.6.3`
- `8.6.2`
- `8.6.1`
- `8.4.4`
- `8.4.3`
- `8.4.2`
- `8.4.1`
- `8.2.2`
- `8.0.2`
- `7.10.3`
Supported versions of Cabal:
**Cabal:**
- `2.0`
- `2.2`
- `2.4`
- `3.0`
- `3.0.0.0` (default)
- `2.4.1.0`
- `2.4.0.0`
- `2.2.0.0`
Recommendation: Cabal is almost always fully backwards compatible and so for most purposes, using the latest available version is sufficient
**Stack:**
- `latest` (recommended) -- follows the latest release automatically.
- `2.1.3`
- `2.1.1`
- `1.9.3.1`
- `1.9.1.1`
- `1.7.1`
- `1.6.5`
- `1.6.3.1`
- `1.6.1.1`
- `1.5.1`
- `1.5.0`
Recommendation: Stack follows SemVer, and additionally attempts to remain backwards compatible across major versions whenever reasonable. Using the latest available version is almost always sufficient
The full list of available versions of GHC, Cabal, and Stack are as follows:
- [Linux/macOS - Cabal and GHC](https://gitlab.haskell.org/haskell/ghcup/blob/master/.available-versions)
- [Windows - Cabal](https://chocolatey.org/packages/cabal#versionhistory).
- [Windows - GHC](https://chocolatey.org/packages/ghc#versionhistory)
- [Linux/macOS/Windows - Stack](https://github.com/commercialhaskell/stack/tags)
Note: 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.
## License
@@ -69,4 +146,4 @@ The scripts and documentation in this project are released under the [MIT Licens
## Contributions
Contributions are welcome! See the [Contributor's Guide](docs/contributors.md).
Contributions are welcome! See the [Contributor's Guide](docs/contributors.md).