https://github.com/k-phoen/action-squawk
🦉 Run squawk in GitHub actions to lint PostgreSQL migrations
https://github.com/k-phoen/action-squawk
Last synced: 4 months ago
JSON representation
🦉 Run squawk in GitHub actions to lint PostgreSQL migrations
- Host: GitHub
- URL: https://github.com/k-phoen/action-squawk
- Owner: K-Phoen
- License: mit
- Created: 2022-02-23T20:21:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-25T15:15:01.000Z (over 3 years ago)
- Last Synced: 2024-10-01T19:33:00.308Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 287 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Action: Squawk
This action runs [squawk](https://github.com/sbdchd/squawk) on pull requests to lint PostgreSQL migrations.
## Usage
```yaml
name: Self test
on: [pull_request]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: squawk
uses: K-Phoen/action-squawk@main
```
## Inputs
### `targets`
**Required**. [Glob pattern](https://github.com/isaacs/minimatch) describing what files to lint. Default is `migrations/*.sql`.
### `exclude`
Optional. Comma-separated checks to exclude (`--exclude` flag from [squawk](https://github.com/sbdchd/squawk)). Default is empty.
### `reporter`
Optional. Reporter of reviewdog command (`-reporter` flag from [reviewdog](https://github.com/reviewdog/reviewdog)). Default is `github-pr-review`.
### `squawk_version`
**Required**. The [squawk](https://github.com/sbdchd/squawk/tags) version to use. Default is `v0.8.2`.
### `reviewdog_version`
**Required**. The [reviewdog](https://github.com/reviewdog/reviewdog) version to use. Default is `0.14.0`.
## License
This action is released under the [MIT](LICENSE) license.