Skip to content

Commit 7984565

Browse files
authored
Update instructions
1 parent ede6168 commit 7984565

File tree

1 file changed

+41
-10
lines changed

1 file changed

+41
-10
lines changed

README.md

Lines changed: 41 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
install-crystal
22
===============
33

4-
[GitHub Action][] to **install [Crystal][] programming language**
4+
[GitHub Action][] to **install [Crystal][] programming language** and [Shards][] package manager.
55

66
Works on Ubuntu, macOS, Windows.
77

8-
On Ubuntu and macOS this also installs `shards`. This will be expanded in the future.
9-
108
## Examples
119

1210
```yaml
@@ -20,10 +18,20 @@ steps:
2018
- uses: actions/checkout@v2
2119
- uses: oprypin/install-crystal@v1
2220
with:
23-
crystal: 0.34.0
21+
crystal: 0.35.0
2422
- run: crystal spec
2523
```
2624
25+
```yaml
26+
steps:
27+
- uses: actions/checkout@v2
28+
- uses: oprypin/install-crystal@v1
29+
with:
30+
shards: true
31+
- run: shards install
32+
```
33+
34+
2735
[Find usages in the wild!](https://github.com/search?l=YAML&q=%22oprypin%2Finstall-crystal%22&type=Code)
2836
2937
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.
@@ -32,17 +40,38 @@ Alternatively, you can use the container-based approach [as in the starter workf
3240
3341
### Inputs
3442
35-
* **`crystal: 0.34.0`** (not supported on Windows)
43+
* * **`crystal: 0.35.0`** (not supported on Windows)
44+
45+
Install a particular release of Crystal.
46+
47+
* **`crystal: latest`** (default; not supported on Windows)
48+
49+
Install the latest released version of Crystal.
50+
51+
* **`crystal: nightly`** (default on Windows)
52+
53+
Install Crystal from the latest continuous build on [crystal.git][] master.
54+
55+
* * **`shards: true`** (default)
56+
57+
Ensure that *some* released version of [Shards][] is available (or `nightly` on Windows).
58+
This uses the build that's bundled with Crystal's releases. Other options are slower, as building Shards is a necessary step then.
59+
60+
* **`shards: false`** (default on Windows)
61+
62+
Ensure that `shards` executable is *not* available.
63+
64+
* **`shards: latest`** (not supported on Windows)
3665

37-
Install a particular release of Crystal.
66+
Build and install the latest released version of Shards.
3867

39-
* **`crystal: latest`** (default; not supported on Windows)
68+
* **`shards: 0.12.0`** (not supported on Windows)
4069

41-
Install the latest released version of Crystal.
70+
Build and install a particular release of Shards.
4271

43-
* **`crystal: nightly`** (default on Windows)
72+
* **`shards: nightly`**
4473

45-
Install Crystal from the latest continuous build on [crystal.git][] master.
74+
Build and install the latest commit of [shards.git][] master.
4675

4776
* **`arch: x86_64`**, **`arch: x86`** (defaults to current OS arch)
4877

@@ -66,4 +95,6 @@ Alternatively, you can use the container-based approach [as in the starter workf
6695
[github action]: https://github.com/features/actions
6796
[crystal]: https://crystal-lang.org/
6897
[crystal.git]: https://github.com/crystal-lang/crystal
98+
[shards]: https://github.com/crystal-lang/shards
99+
[shards.git]: https://github.com/crystal-lang/shards
69100
[crystal-starter]: https://github.com/actions/starter-workflows/blob/master/ci/crystal.yml

0 commit comments

Comments
 (0)