Skip to content

Commit a384662

Browse files
committed
Update doc
1 parent ab4075d commit a384662

File tree

2 files changed

+31
-10
lines changed

2 files changed

+31
-10
lines changed

README.md

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,32 @@ steps:
1818
- uses: actions/checkout@v2
1919
- uses: oprypin/install-crystal@v1
2020
with:
21-
crystal: 0.35.0
21+
crystal: 0.35.1
22+
- run: shards install
2223
- run: crystal spec
2324
```
2425
2526
```yaml
26-
steps:
27-
- uses: actions/checkout@v2
28-
- uses: oprypin/install-crystal@v1
29-
with:
30-
shards: true
31-
- run: shards install
27+
strategy:
28+
fail-fast: false
29+
matrix:
30+
include:
31+
- {os: ubuntu-latest, crystal: latest}
32+
- {os: ubuntu-latest, crystal: nightly}
33+
- {os: macos-latest}
34+
- {os: windows-latest}
35+
runs-on: ${{matrix.os}}
36+
steps:
37+
- uses: oprypin/install-crystal@v1
38+
with:
39+
crystal: ${{matrix.crystal}}
40+
- uses: actions/checkout@v2
41+
- run: shards install
42+
- run: crystal spec
43+
- run: crystal tool format --check
44+
if: matrix.crystal == 'latest'
3245
```
3346
34-
3547
[Find usages in the wild!](https://github.com/search?l=YAML&q=%22oprypin%2Finstall-crystal%22&type=Code)
3648
3749
Alternatively, you can use the container-based approach [as in the starter workflow][crystal-starter] (without this action), but the advantage here is the unified approach to installation across 3 systems.
@@ -40,7 +52,7 @@ Alternatively, you can use the container-based approach [as in the starter workf
4052
4153
### Inputs
4254
43-
* * **`crystal: 0.35.0`** (not supported on Windows)
55+
* * **`crystal: 0.35.1`** (not supported on Windows)
4456

4557
Install a particular release of Crystal.
4658

@@ -79,7 +91,7 @@ Alternatively, you can use the container-based approach [as in the starter workf
7991

8092
* **`destination: some/path`**
8193

82-
The directory to store Crystal in, after extracting.
94+
The directory to store Crystal in, after extracting. Will directly affect `outputs.path` (the default is in a temporary location).
8395

8496
* **`token: ${{ github.token }}`**
8597

@@ -91,6 +103,13 @@ Alternatively, you can use the container-based approach [as in the starter workf
91103

92104
The actual version of Crystal (as a ref in crystal-lang/[crystal.git][]) that was installed.
93105

106+
* **`shards`** (`${{ steps.some_step_id.outputs.shards }}`)
107+
108+
The actual version of Shards (as a ref in crystal-lang/[shards.git][]) that was installed.
109+
110+
* **`path`** (`${{ steps.some_step_id.outputs.path }}`)
111+
112+
The path where Crystal was extracted to, so you can use '[path]/bin/crystal', '[path]/src' etc.
94113

95114
[github action]: https://github.com/features/actions
96115
[crystal]: https://crystal-lang.org/

action.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ inputs:
1515
outputs:
1616
crystal:
1717
description: The actual version of Crystal that was installed
18+
shards:
19+
description: The actual version of Shards that was installed
1820
path:
1921
description: The directory where Crystal was installed
2022
runs:

0 commit comments

Comments
 (0)