Skip to content

Commit

Permalink
Add Readme with example usage.
Browse files Browse the repository at this point in the history
  • Loading branch information
davidcraig committed Jun 29, 2020
1 parent 55ea1ab commit e049cf3
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# WoW Lua Lint

This action will lint all lua files specified for a given repository and check for any syntax issues (under the hood it uses `luac -p path/to/files`)

## Usage

The following shows an example of how to use this action in a workflow.

.github/workflows/lint.yml

```yaml
name: Lint
on: [push]

jobs:
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v2
with:
repository: 'ps-wow/action-test-repo'
- name: wow-lint
uses: davidcraig/[email protected]
with:
path-to-files: 'src/test.lua'
```

0 comments on commit e049cf3

Please sign in to comment.