Skip to content

Commit 6f1886e

Browse files
committed
Add Zephyr to supported toools
1 parent 17b32fb commit 6f1886e

File tree

2 files changed

+24
-2
lines changed

2 files changed

+24
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,19 @@ A GitHub Action which sets up a PureScript toolchain for CI. Contains the follow
44

55
- The [PureScript compiler](https://github.com/purescript/purescript)
66
- The [Spago package manager and build tool](https://github.com/purescript/spago)
7+
- The [Zephyr dead code elimination tool](https://github.com/coot/zephyr)
8+
9+
This action is designed to support tools with static binaries. Your PureScript project may also depend on tooling and libraries provided by the NPM ecosystem, in which case you will also want to use the [setup-node](https://github.com/actions/setup-node) action.
10+
11+
> Note: While this action does work, it is currently under development and the API may change. Feel free to experiment using it, but it won't be stable until a v1 release when the PureScript Contributor organization switches to use it.
712
813
## Usage
914

1015
See the [action.yml](action.yml) file for all possible inputs and outputs.
1116

1217
### Basic
1318

14-
Get the latest versions of PureScript and Spago in the environment:
19+
Get the latest versions of PureScript, Spago, and Zephyr in the environment:
1520

1621
```yaml
1722
steps:
@@ -22,7 +27,7 @@ steps:
2227
2328
### Use Specific Versions
2429
25-
Use specific versions of PureScript and/or Spago by supplying a valid semantic version (only exact versions currently supported):
30+
Use specific versions of any tool by supplying a valid semantic version (only exact versions currently supported):
2631
2732
```yaml
2833
steps:
@@ -31,5 +36,19 @@ steps:
3136
with:
3237
purescript-version: "0.13.8"
3338
spago-version: "0.15.3"
39+
zephyr-version: "0.3.2"
40+
- run: spago build
41+
```
42+
43+
### Cache Library Dependencies (Coming Soon)
44+
45+
Automatically build and cache library dependencies between workflow runs by supplying a path to a Spago config file:
46+
47+
```yaml
48+
steps:
49+
- uses: actions/checkout@v2
50+
- uses: thomashoneyman/setup-purescript@master
51+
with:
52+
cache: "spago.dhall"
3453
- run: spago build
3554
```

action.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ inputs:
88
spago-version:
99
description: "The Spago version to install. Examples: latest, 0.15.3"
1010
default: "latest"
11+
zephyr-version:
12+
description: "The Zephyr version to install. Examples: latest, 0.3.2"
13+
default: "latest"
1114
runs:
1215
using: "node12"
1316
main: "dist/index.js"

0 commit comments

Comments
 (0)