Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jkl1337 committed Feb 20, 2024
1 parent 5dd5f97 commit 649e9da
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# Github Action for LuaRocks

### `leafo/gh-actions-luarocks`
### `jkl1337/gh-actions-luarocks`

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

Builds and installs LuaRocks from source into the `.luarocks/` directory in the working directory. Configures `PATH`, `LUA_PATH`, and `LUA_CPATH` environment variables to be able to use the `luarocks` command directly in workflows, and require installed modules in Lua.

[`leafo/gh-actions-lua`](https://github.com/marketplace/actions/install-lua-luajit) can be used to install Lua, which is required for LuaRocks to build and run. (This action will use any Lua installed in `.lua/`).
[`jkl1337/gh-actions-lua`](https://github.com/marketplace/actions/install-lua-luajit) can be used to install Lua, which is required for LuaRocks to build and run. (This action will use any Lua installed in `.lua/`).

## Usage

Installs Lua, LuaRocks, then install a module:

```yaml
- uses: leafo/gh-actions-lua@v9
- uses: leafo/gh-actions-luarocks@v4
- uses: jkl1337/gh-actions-lua@v11
- uses: jkl1337/gh-actions-luarocks@v5

# Install some package
- name: install a module
run: luarocks install moonscript
```

For a more complete example see: https://github.com/leafo/gh-actions-lua/blob/master/README.md#full-example
For a more complete example see: https://github.com/jkl1337/gh-actions-lua/blob/master/README.md#full-example

## Inputs

Expand All @@ -34,7 +34,7 @@ Specifies which version of LuaRocks to install. Must be listed on https://luaroc
Example:

```yaml
- uses: leafo/gh-actions-luarocks@v4
- uses: jkl1337/gh-actions-luarocks@v5
with:
luarocksVersion: "3.1.3"
```
Expand All @@ -44,13 +44,13 @@ Example:
**Default**: `null` (Optional)

Manually specify the path to an existing Lua installation to use. This is not
necessary if you are using `leafo/gh-actions-lua`. Will build LuaRocks with
necessary if you are using `jkl1337/gh-actions-lua`. Will build LuaRocks with
`./configure --with-lua=$withLuaPath`

Example:

```yaml
- uses: leafo/gh-actions-luarocks@v4
- uses: jkl1337/gh-actions-luarocks@v5
with:
withLuaPath: "/usr/local/openresty/luajit/"
```
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

name: "Install LuaRocks"
name: "Install LuaRocks (latest)"
description: "Download, build, and install LuaRocks for use with scripts, tests, and more"

branding:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "leaf corcoran <leafot@gmail.com>",
"author": "John Luebs <john@luebs.org>",
"license": "MIT",
"dependencies": {
"@actions/core": "^1.2.6",
Expand Down

0 comments on commit 649e9da

Please sign in to comment.