https://github.com/sbdchd/squawk-action

Github Action for Linting Postgres Migrations with Squawk
https://github.com/sbdchd/squawk-action

github-actions postgres

Last synced: 9 months ago
JSON representation

Github Action for Linting Postgres Migrations with Squawk

• Host: GitHub
• URL: https://github.com/sbdchd/squawk-action
• Owner: sbdchd
• Created: 2022-07-26T18:29:23.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-04-09T13:43:49.000Z (9 months ago)
• Last Synced: 2025-04-18T00:11:11.823Z (9 months ago)
• Topics: github-actions, postgres
• Language: PLpgSQL
• Homepage: https://github.com/sbdchd/squawk
• Size: 214 KB
• Stars: 11
• Watchers: 2
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          
# squawk-action ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/sbdchd/squawk-action?display_name=tag&sort=semver)

A GitHub Action for [Squawk](https://github.com/sbdchd/squawk).

Lint Postgres migrations and report violations as a comment in a GitHub Pull Request ([example PR](https://github.com/sbdchd/squawk/pull/14#issuecomment-647009446)).

For more information on Squawk, see the [Squawk GitHub repository](https://github.com/sbdchd/squawk) or [website](https://squawkhq.com).

## basic usage

Lint every .sql file in `migrations/` on every pull request.

```yml

# .github/workflows/lint-migrations.yml

name: Lint Migrations

on: pull_request

jobs:

  lint_migrations:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - uses: sbdchd/squawk-action@v2

        with:

          pattern: "migrations/*.sql"

          version: "latest"

```

## advanced usage

Only lint modified .sql files in the `migrations/`.

```yml

# .github/workflows/lint-migrations.yml

name: Lint Migrations

on: pull_request

jobs:

  lint_migrations:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

        with:

          fetch-depth: 0

      - name: Find modified migrations

        run: |

          modified_migrations=$(git diff --diff-filter=d --name-only origin/$GITHUB_BASE_REF...origin/$GITHUB_HEAD_REF 'migrations/*.sql')

          echo "$modified_migrations"

          echo "file_names=$modified_migrations" >> $GITHUB_OUTPUT

        id: modified-migrations

      - uses: sbdchd/squawk-action@v2

        with:

          files: ${{ steps.modified-migrations.outputs.file_names }}

```

> [!TIP]

> See `action.yml` for more action inputs.

## example report

[![Example Squawk PR Comment](./squawk-pr-comment.png)](https://github.com/sbdchd/squawk/pull/14#issuecomment-647009446)

## development

### releasing a new version

1. [Release a new version](https://github.com/sbdchd/squawk-action/releases) (e.g. v5.2.1)

2. Update major version tag to point to commit.

   ```bash

   git tag v5

   git push --tags

   ```