sbdchd/squawk-actionPublic

NotificationsYou must be signed in to change notification settings
Fork12
Star13

Github Action for Linting Postgres Migrations with Squawk

github.com/sbdchd/squawk

13 stars 12 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Use this GitHub action with your project

Add this Action to an existing workflow or create a new one

View on Marketplace

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 22 Commits
.github		.github
CHANGELOG.md		CHANGELOG.md
README.md		README.md
action.yml		action.yml
example.sql		example.sql
squawk-pr-comment.png		squawk-pr-comment.png

Repository files navigation

squawk-action

A GitHub Action forSquawk.

Lint Postgres migrations and report violations as a comment in a GitHub Pull Request (example PR).

For more information on Squawk, see theSquawk GitHub repository orwebsite.

basic usage

Lint every .sql file inmigrations/ on every pull request.

# .github/workflows/lint-migrations.ymlname:Lint Migrationson:pull_requestjobs:lint_migrations:runs-on:ubuntu-lateststeps:      -uses:actions/checkout@v4      -uses:sbdchd/squawk-action@v2with:pattern:"migrations/*.sql"version:"latest"

advanced usage

Only lint modified .sql files in themigrations/.

# .github/workflows/lint-migrations.ymlname:Lint Migrationson:pull_requestjobs:lint_migrations:runs-on:ubuntu-lateststeps:      -uses:actions/checkout@v4with:fetch-depth:0      -name:Find modified migrationsrun:|          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_OUTPUTid:modified-migrations      -uses:sbdchd/squawk-action@v2with:files:${{ steps.modified-migrations.outputs.file_names }}