https://github.com/ragedunicorn/action-luacheck
A github action that uses luacheck to lint full codebases or specific files
https://github.com/ragedunicorn/action-luacheck
actions github-actions lint lua luacheck
Last synced: about 1 month ago
JSON representation
A github action that uses luacheck to lint full codebases or specific files
- Host: GitHub
- URL: https://github.com/ragedunicorn/action-luacheck
- Owner: RagedUnicorn
- License: mit
- Created: 2021-10-22T16:37:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-22T17:41:28.000Z (over 4 years ago)
- Last Synced: 2024-10-14T09:44:08.485Z (over 1 year ago)
- Topics: actions, github-actions, lint, lua, luacheck
- Homepage:
- Size: 44.9 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# action-luacheck
> A GitHub action that uses luacheck to lint full codebases or specific files
This action runs as a Docker container using
[ragedunicorn/docker-luacheck](https://github.com/RagedUnicorn/docker-luacheck) and therefore only
runs on Linux runners (`ubuntu-*`).
# How to use
#### Basic usage
```yaml
on: [push]
jobs:
lint-luacheck:
runs-on: ubuntu-latest
name: Luacheck linting
steps:
- name: Checkout Repository
uses: actions/checkout@v2
- name: Run Luacheck
uses: RagedUnicorn/action-luacheck@[version]
```
#### Custom Path and Arguments
```yaml
on: [push]
jobs:
lint-luacheck:
runs-on: ubuntu-latest
name: Luacheck linting
steps:
- name: Checkout Repository
uses: actions/checkout@v2
- name: Run Luacheck
uses: RagedUnicorn/action-luacheck@[version]
with:
files: code/
args: -q
```
# Inputs
| Name | Required | Default | Description |
|---------|----------|---------|----------------------------------------------------------------------------------------------------------------------|
| `files` | no | `.` | List of files or directories to lint, resolved relative to the repository root. |
| `args` | no | _empty_ | Extra command-line arguments forwarded to luacheck. See the [luacheck CLI docs](https://luacheck.readthedocs.io/en/stable/cli.html). |
# License
MIT License
Copyright (c) 2026 Michael Wiesendanger
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.