Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xpol/setup-lua
GitHub action to setup Lua.
https://github.com/xpol/setup-lua
Last synced: about 2 months ago
JSON representation
GitHub action to setup Lua.
- Host: GitHub
- URL: https://github.com/xpol/setup-lua
- Owner: xpol
- License: mit
- Created: 2019-10-28T12:53:20.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-11T01:38:57.000Z (about 1 year ago)
- Last Synced: 2024-04-14T08:52:48.335Z (5 months ago)
- Language: CMake
- Size: 378 KB
- Stars: 10
- Watchers: 2
- Forks: 9
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xpol/setup-lua
[](https://github.com/xpol/setup-lua/actions?workflow=test)
Github Action to install Lua/LuaJIT on Unbutu/macOS/Windows.
Builds and installs Lua into the `.lua/` directory in the working directory using [CMake](https://cmake.org/).
Adds the `.lua/bin` to the `PATH` environment variable so `lua` can be called
directly in workflows.
This project is hightlly inspired by (and this README is initially copied from) [leafo/gh-actions-lua](https://github.com/leafo/gh-actions-lua). The difference is this project use CMake to support Unbutu/macOS/Windows.
Many thanks to [leafo](https://github.com/leafo)!
## Usage
Install Lua:
*Will install the latest stable release of PUC-Rio Lua.*
```yaml
- uses: xpol/setup-lua@v1
```
Install specific version of Lua:
```yaml
- uses: xpol/setup-lua@v1
with:
lua-version: "5.1.5"
```
Install specific version of LuaJIT:
```yaml
- uses: xpol/setup-lua@v1
with:
lua-version: "luajit-2.0.5"
```
## Inputs
### `lua-version`
**Default**: `"5.3.5"`
Specifies the version of Lua to install. The version name instructs the action
where to download the source from.
All supported of versions:
* `"5.3.5"`
* `"5.3.4"`
* `"5.3.3"`
* `"5.3.2"`
* `"5.3.1"`
* `"5.3.0"`
* `"5.2.4"`
* `"5.2.3"`
* `"5.2.2"`
* `"5.2.1"`
* `"5.2.0"`
* `"5.1.5"`
* `"5.1.4"`
* `"5.1.3"`
* `"5.1.2"`
* `"5.1.1"`
* `"5.1.0"`
* `"luajit-2.0.5"`
* `"luajit-2.1.0-beta3"`
* `"luajit-2.1.0-beta2"`
* `"luajit-2.1.0-beta1"`
* `"luajit-2.0.4"`
* `"luajit-2.0.3"`
* `"luajit-2.0.2"`
* `"luajit-2.0.1"`
* `"luajit-2.0.0"`
*Note: Beta versions will removed when the stable version is released.*
## Also want LuaRocks
You may also need an action to install luarocks:
* [`leafo/gh-actions-luarocks`](https://github.com/leafo/gh-actions-luarocks)
* inputs: `luarocksVersion`
## Full Example
This example is for running tests on a Lua module that uses LuaRocks for
dependencies and [busted](https://olivinelabs.com/busted/) for a test suite.
Create `.github/workflows/test.yml` in your repository:
```yaml
name: test
on: [push]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: xpol/setup-lua@v1
with:
lua-version: "5.1.5"
- uses: leafo/gh-actions-luarocks@v2
- name: build
run: |
luarocks install busted
luarocks make
- name: test
run: |
busted -o utfTerminal
```
This example:
* Uses Lua 5.1.5 — You can use another version by chaning the `lua-version` varible. LuaJIT versions can be used by prefixing the version with `luajit-`, i.e. `luajit-2.1.0-beta3`
* Uses a `.rockspec` file the root directory of your repository to install dependencies and test packaging the module via `luarocks make`
View the documentation for the individual actions (linked above) to learn more about how they work.
### Version build matrix
You can test against multiple versions of Lua using a matrix strategy:
```yaml
jobs:
test:
strategy:
matrix:
luaVersion: ["5.1.5", "5.2.4", "luajit-2.1.0-beta3"]
steps:
- uses: actions/checkout@master
- uses: xpol/setup-lua@v1
with:
lua-version: ${{ matrix.luaVersion }}
# ...
```