README.md

Github Action for Lua and LuaJIT

jkl1337/gh-actions-lua

This is a fork of leafo/gh-action-lua.

Builds and installs Lua into the .lua/ directory in the working directory. Adds the .lua/bin to the PATH environment variable so lua can be called directly in workflows.

In addition to a few bug fixes this action works with most versions of LuaJIT including the current development branch and openresty branch. It also installs LuaJIT "properly" on Windows per documentation including a correctly installed jit.* library.

Other Lua GitHub actions:

• jkl1337/gh-actions-luarocks
  • inputs: luarocksVersion

Usage

Install Lua: (Will typically default to the latest release, 5.4.4 as of this readme)

- uses: jkl1337/gh-actions-lua@v11

Install specific version of Lua:

- uses: jkl1337/gh-actions-lua@v11
  with:
    luaVersion: "5.1.5"

Install LuaJIT openresty:

- uses: jkl1337/gh-actions-lua@v11
  with:
    luaVersion: "luajit-openresty"

Install LuaJIT latest git:

- uses: jkl1337/gh-actions-lua@v11
  with:
    luaVersion: "luajit-git"

Install specific version of LuaJIT:

- uses: jkl1337/gh-actions-lua@v11
  with:
    luaVersion: "luajit-2.1.0-beta3"

When using Windows the following prerequisite action must be run before building PUC-Lua (not LuaJIT): ilammy/msvc-dev-cmd@v1. It is safe to include this line on non-Windows platforms, as the action will do nothing in those cases.

- uses: ilammy/msvc-dev-cmd@v1
- uses: jkl1337/gh-actions-lua@v11

Inputs

luaVersion

Default: "5.4"

Specifies the version of Lua to install. The version name instructs the action where to download the source from.

Examples of versions:

• "5.1.5"
• "5.2.4"
• "5.3.5"
• "5.4.1"
• "luajit-2.0.5"
• "luajit-2.1.0-beta3"
• "luajit-openresty"
• "luajit-git"

The version specifies where the source is downloaded from:

• luajit-openresty — will always pull master from https://github.com/openresty/luajit2
• luajit-git — will pull the default branch from https://github.com/LuaJIT/LuaJIT
• Anything starting with luajit- — from http://luajit.org/download.html
• Anything else — from https://www.lua.org/ftp/

Version aliases

You can use shorthand 5.1, 5.2, 5.3, 5.4, luajit version aliases to point to the latest (or recent) version of Lua for that version. luajit points to openresty.

luaCompileFlags

Default: ""

Additional flags to pass to make when building Lua.

Example value:

- uses: jkl1337/gh-actions-lua@master
  with:
    luaVersion: 5.3
    luaCompileFlags: LUA_CFLAGS="-DLUA_INT_TYPE=LUA_INT_INT"

Note that compile flags may work differently across Lua and LuaJIT.

Full Example

This example is for running tests on a Lua module that uses LuaRocks for dependencies and busted for a test suite.

Create .github/workflows/test.yml in your repository:

name: test

on: [push]

jobs:
  test:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@master

    - uses: jkl1337/gh-actions-lua@v11
      with:
        luaVersion: "5.1.5"

    - uses: jkl1337/gh-actions-luarocks@v4

    - 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 luaVersion 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:

jobs:
  test:
    strategy:
      matrix:
        luaVersion: ["5.1.5", "5.2.4", "luajit-openresty"]

    steps:
    - uses: actions/checkout@master
    - uses: jkl1337/gh-actions-lua@v11
      with:
        luaVersion: ${{ matrix.luaVersion }}

    # ...