StyLua GitHub Action

GitHub Action to run StyLua, a Lua code formatter.

Installs the StyLua binary (from GitHub releases), and caches it. Any StyLua command can then be run.

NOTE: We recommend using a toolchain manager such as aftman to manage StyLua, as it allows you to define the version used throughout your project - both on the command line, and in GitHub actions.

Usage

- uses: actions/checkout@v4
- uses: JohnnyMorganz/stylua-action@v4
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    version: latest # NOTE: we recommend pinning to a specific version in case of formatting changes
    # CLI arguments
    args: --check .

If you would just like to install stylua, but not run it (e.g., since it is used as part of a wider CI script), then you can set args: false:

- uses: actions/checkout@v4
- uses: JohnnyMorganz/stylua-action@v4
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    version: latest # NOTE: we recommend pinning to a specific version in case of formatting changes
    # This disables running `stylua`
    args: false
  # Run stylua independently
- run: |
    stylua --version

Parameters

token (Required)

GitHub token. Required since the binary is downloaded from GitHub releases (to speed download)

args (Required)

The arguments to pass to the StyLua binary. If you don't want to run the binary, set args: false.

version (Required)

The version of StyLua to use. Follows semver syntax. Alternatively, supply latest to use the latest available release.

NOTE: using latest may cause the action to fail if StyLua updates and the formatting changes!

Based off https://github.com/Roblox/setup-foreman, licensed under MIT