drizzle-migration-guard

Explain Drizzle migration collisions in pull requests.

English · 简体中文

Contributing · Support · Security · Maintainers

drizzle-migration-guard wraps drizzle-kit check, turns raw failures into a short diagnosis, and leaves a sticky PR comment with concrete next steps when your migration history collides.

Drizzle already ships drizzle-kit check, but the default output still makes reviewers jump between logs, local repro steps, and migration snapshots. This action adds the experience layer:

• Auto-detects drizzle.config.ts in the working directory.
• Skips itself when the PR does not touch Drizzle config, schema, or migration files.
• Normalizes failures into collision/history, config/dependency, or unknown.
• Writes a GitHub Actions summary and a sticky PR comment with a fix recipe.
• Blocks the PR only for collision/history by default.

Use the latest major tag in workflows so you automatically receive compatible patch updates.

name: drizzle-migration-guard

on:
  pull_request:
    paths:
      - "drizzle.config.ts"
      - "src/db/**"
      - "drizzle/**"
      - "package.json"
      - "package-lock.json"

jobs:
  guard:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm

      - run: npm ci

      - uses: saudademjj/drizzle-migration-guard@v1
        with:
          github-token: ${{ github.token }}

Use working-directory to choose which package should run drizzle-kit check, and use config when the config file is not the default drizzle.config.* in that directory.

name: drizzle-migration-guard-monorepo

on:
  pull_request:
    paths:
      - "packages/api/**"
      - "package.json"
      - "package-lock.json"
      - "pnpm-lock.yaml"

jobs:
  guard-api:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm

      - run: npm ci

      - uses: saudademjj/drizzle-migration-guard@v1
        with:
          github-token: ${{ github.token }}
          working-directory: packages/api
          config: drizzle.config.ts

• Default discovery only checks the first root-level drizzle.config.* file it finds.
• Multi-config support is explicit by design. Pass config paths through the config input.
• The action expects drizzle-kit to be available in the checked-out project. It calls npx --no-install drizzle-kit check.
• Non-blocking failures still appear in the step summary and comment, but only collision/history fails the job by default.
• Package-local package.json and common lockfiles are treated as relevant PR changes, so monorepo packages do not get skipped when dependencies move.
• Renamed PR files are matched against both the current path and the previous path reported by GitHub.

This usually means the PR did not touch the config file, schema files, migration directory, or package manifest paths tracked for that config. In monorepos, double-check that working-directory points at the package that owns the Drizzle config.

Install drizzle-kit before the action runs, usually with npm ci, pnpm install --frozen-lockfile, or your team's equivalent. The action calls npx --no-install drizzle-kit check, so it expects the dependency to already exist in CI.

That happens when github-token is missing. Without it, the action cannot read the PR file list from GitHub, so it falls back to checking every discovered config.

This repository intentionally omits committed GitHub workflow files because GitHub Marketplace requires published action repositories to stay workflow-free.

npm install
npm run build
npm test

See CONTRIBUTING.md for contribution workflow, validation expectations, and PR guidance, CODE_OF_CONDUCT.md for community standards, and SECURITY.md for vulnerability reporting guidance. For support paths and maintainer expectations, see SUPPORT.md and MAINTAINERS.md.

MIT