Alembic Migration Lint with Squawk
ActionsTags
(2)Lint Alembic Postgres migrations and report violations as a comment in a GitHub Pull Request.
- It identifies changed migration files, generates the corresponding SQL, and runs Squawk to check for any issues.
- Based on squawk-action
migrations_path: Path to the folder containing your 'versions' subfolder. (required)alembic_config: Path to alembic.ini. (optional, default: "alembic.ini")runner: Command prefix for running Python commands. Use "poetry" for Poetry, "pipenv" for Pipenv, "uv" for uv, or leave empty (or set to "none") to use the system interpreter. (optional, default: "poetry")
changed: Indicates whether any new migrations were found and processed.
Here is an example of how to use this action in a GitHub workflow:
name: Lint Alembic Migrations
on:
pull_request:
types: [ opened, synchronize, reopened, ready_for_review ]
branches: [main]
permissions:
contents: read
pull-requests: write
jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version-file: 'pyproject.toml'
cache: 'poetry'
- name: Install dependencies
run: poetry install
- name: Lint Alembic Migrations
uses: remedyproduct/alembic-squawk-action@v0.0.1
with:
migrations_path: 'migrations'
alembic_config: 'alembic.ini'
runner: 'poetry'
Alembic Migration Lint with Squawk is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
Tags
(2)Alembic Migration Lint with Squawk is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.