K-Phoen / action-squawk

🦉 Run squawk in GitHub actions to lint PostgreSQL migrations

GitHub Action: Squawk

This action runs squawk on pull requests to lint PostgreSQL migrations.

Usage

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 describing what files to lint. Default is migrations/*.sql.

exclude

Optional. Comma-separated checks to exclude (--exclude flag from squawk). Default is empty.

reporter

Optional. Reporter of reviewdog command (-reporter flag from reviewdog). Default is github-pr-review.

squawk_version

Required. The squawk version to use. Default is v0.8.2.

reviewdog_version

Required. The reviewdog version to use. Default is 0.14.0.

License

This action is released under the MIT license.