/luacheck-action

Run a luacheck. Typically used for Factorio mod sources

Primary LanguageShellMIT LicenseMIT

GitHub Action for luacheck

This action will run your mod code through luacheck.

Usage

This action can be used with a repository contain a Factorio mod at base level.

The action can be used as follows:

on: push
name: Check & Release
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - name: lint
        uses: Roang-zero1/factorio-mod-luacheck@master
        with:
          luacheckrc_url: https://raw.githubusercontent.com/Nexela/Factorio-luacheckrc/0.17/.luacheckrc

Sample Workflow

A sample workflow that uses this action can be found at Roang-zero1/factorio-mod-actions

Inputs

luacheckrc_url

URL to the luacheckrc configuration file to be used during checking.
Default: https://raw.githubusercontent.com/Nexela/Factorio-luacheckrc/0.17/.luacheckrc

Recommended luacheckrc

For current luacheckrc to use with factorio I recommend Nexela/Factorio-luacheckrc