Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Kleidukos committed Mar 7, 2024
1 parent d4a41f1 commit 560d838
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,14 @@ The inputs of the action (under the `with:` stanza) are the following:
* cabal-file:
The path to your cabal file, e.g. somefolder/myproject.cabal. required;
* version: Version of the tool. required;
* windows: Enable Windows runner. not required, defaults to false;
* macos: Enable macOS runner. not required, defaults to false;
* ubuntu: Enable Ubuntu runner. not required, defaults to false.
* windows: (legacy) Enable Windows runner, latest version. required: false, default: false;
* windows-version: Enable Windows runner. If both `windows` and `windows-version` inputs are set, the explicit version will take priority. required: false, default: "";
* macos: (legacy) Enable macOS runner, latest version. required: false, default: false;
* macos-version: Enable macOS runner. If both `macos` and `macos-version` inputs are set, the explicit version will take priority. required: false, default: "";
* ubuntu: (legacy) Enable Ubuntu runner, latest version. required: false, default: false;
* ubuntu-version: Enable Ubuntu runner. If both `ubuntu` and `ubuntu-version` inputs are set, the explicit version will take priority. required: false, default: "".

One of the three OS inputs is required however. See below for an example:
See below for an example:

```yaml
jobs:
Expand All @@ -25,11 +28,12 @@ jobs:
steps:
- name: Extract the tested GHC versions
id: set-matrix
uses: kleidukos/[email protected].6.0
uses: kleidukos/[email protected].7.0
with:
cabal-file: get-tested.cabal
ubuntu: true
version: 0.1.6.0
ubuntu-version: "latest"
macos-version: "13"
version: 0.1.7.0
tests:
name: ${{ matrix.ghc }} on ${{ matrix.os }}
needs: generate-matrix
Expand Down

0 comments on commit 560d838

Please sign in to comment.