Skip to content

Commit 35bcb06

Browse files
committed
update readme
1 parent eafb82c commit 35bcb06

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

+15-6
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
[![Actions Status](https://github.com/leafo/gh-actions-lua/workflows/test/badge.svg)](https://github.com/leafo/gh-actions-lua/actions)
66

7-
**Update Nov 18, 2020**: You must use version 8 or greater as GitHub has
7+
**Note**: You must use version 8 or greater as GitHub has
88
deprecated older versions of the actions core libraries.
99

1010
Builds and installs Lua into the `.lua/` directory in the working directory.
@@ -22,25 +22,34 @@ Other Lua GitHub actions:
2222
Install Lua: (Will typically default to the latest release, 5.4.4 as of this readme)
2323

2424
```yaml
25-
- uses: leafo/gh-actions-lua@v9
25+
- uses: leafo/gh-actions-lua@v10
2626
```
2727
2828
Install specific version of Lua:
2929
3030
```yaml
31-
- uses: leafo/gh-actions-lua@v9
31+
- uses: leafo/gh-actions-lua@v10
3232
with:
3333
luaVersion: "5.1.5"
3434
```
3535
3636
Install specific version of LuaJIT:
3737
3838
```yaml
39-
- uses: leafo/gh-actions-lua@v9
39+
- uses: leafo/gh-actions-lua@v10
4040
with:
4141
luaVersion: "luajit-2.1.0-beta3"
4242
```
4343
44+
When using Windows the following prerequisite action must be run before
45+
building Lua: [`ilammy/msvc-dev-cmd@v1`](https://github.com/ilammy/msvc-dev-cmd). It is safe to
46+
include this line on non-Windows platforms, as the action will do nothing in those cases.
47+
48+
```yaml
49+
- uses: ilammy/msvc-dev-cmd@v1
50+
- uses: leafo/gh-actions-lua@v10
51+
```
52+
4453
## Inputs
4554

4655
### `luaVersion`
@@ -107,7 +116,7 @@ jobs:
107116
steps:
108117
- uses: actions/checkout@master
109118
110-
- uses: leafo/gh-actions-lua@v9
119+
- uses: leafo/gh-actions-lua@v10
111120
with:
112121
luaVersion: "5.1.5"
113122
@@ -144,7 +153,7 @@ jobs:
144153
145154
steps:
146155
- uses: actions/checkout@master
147-
- uses: leafo/gh-actions-lua@v9
156+
- uses: leafo/gh-actions-lua@v10
148157
with:
149158
luaVersion: ${{ matrix.luaVersion }}
150159

0 commit comments

Comments
 (0)