Skip to content

README.md

Latest commit

 

History

History
35 lines (23 loc) · 1.29 KB

README.md

File metadata and controls

35 lines (23 loc) · 1.29 KB

StyLua GitHub Action stylua-action status

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.

Usage

- uses: actions/checkout@v2
- uses: JohnnyMorganz/[email protected]
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    # CLI arguments
    args: --check .
    # Specify `version` to pin a specific version, otherwise action will always use latest version/automatically update

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

version (Optional)

The version of StyLua to use. Follows semver syntax. If not specified, installs the latest release. It is recommended to pin your version so that updates to StyLua don't lead to unwanted changes in the action without explicitly updating.

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