Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
ain committed Dec 9, 2023
1 parent 56acbeb commit 347e4ce
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,26 @@
# falco-github-action
Falco GitHub Action for VCL validation at CI level

Falco GitHub Action for VCL validation.

## Usage

```yaml
- name: Lint VCL
uses: ain/falco-github-action@latest
with:
subcommand: lint
options: "-v -I test/vcl/includes"
target: test/vcl/valid_with_include.vcl
```
## Inputs
| Input | Default | Description |
| ----- | ------- | ----------- |
| `subdommand` | `lint` | Run linting on VCL (or ACL) |
| `options` | - | Optional flags, see [Common Flags of Falco](https://github.com/ysugimoto/falco#usage) |
| `target` | - | VCL (or ACL) to targeted, e.g. lint |

## Licence

Copyright © 2023 Ain Tohvri. Licenced under [MIT](LICENSE).

0 comments on commit 347e4ce

Please sign in to comment.