Check in CI

Use seampact check in CI to fail the build when the generated code or an OpenAPI document no longer matches the contract. Run the commands in the app folder. Each stack types them differently: see commands per stack. The lines below use npx for Node.

Try it locally

Change the contract (see diff), then check the generated code.

npx seampact check

You see check.generated.drift. check exits with 1 on drift. Run npx seampact generate to fix it. When nothing drifted you see check: the generated files and documents match the committed ones.

check compares a generated folder you commit. On Spring Boot the build writes the files and nobody commits them: see Generated files.

Run it in GitHub Actions

Every stack uses the same job: check out the code, install the tools, lint the contract, check the generated files, and run your own tests. Only the install and run lines change. Open your stack.

Node

name: seampact
on: [pull_request]
jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with: { node-version: 24 }
      - run: npm ci
      - run: npx seampact lint
      - run: npx seampact check
      - run: npm test

Java: Gradle or Maven

seampactCheck runs in ./gradlew check, and the Maven plugin runs check in verify, so the build is the check. Lint with the compiler binary.

name: seampact
on: [pull_request]
jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-java@v4
        with: { distribution: temurin, java-version: 21 }
      - run: |
          curl -fsSLo seampact https://github.com/jubasse/seampact/releases/latest/download/seampact-linux-x64
          chmod +x seampact
      - run: ./seampact lint
      - run: ./gradlew check             # Maven: ./mvnw verify

PHP: Laravel, Symfony

name: seampact
on: [pull_request]
jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: shivammathur/setup-php@v2
        with: { php-version: "8.3" }
      - run: composer install --no-interaction
      - run: |
          curl -fsSLo seampact https://github.com/jubasse/seampact/releases/latest/download/seampact-linux-x64
          chmod +x seampact
      - run: ./seampact lint
      - run: vendor/bin/seampact check
      - run: vendor/bin/phpunit          # your own tests

Python: FastAPI, Django REST Framework, Django Ninja

name: seampact
on: [pull_request]
jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: astral-sh/setup-uv@v5
      - run: uv sync
      - run: |
          curl -fsSLo seampact https://github.com/jubasse/seampact/releases/latest/download/seampact-linux-x64
          chmod +x seampact
      - run: ./seampact lint
      - run: uv run seampact check       # Django: uv run python manage.py seampact_check
      - run: uv run pytest               # your own tests

The lint step of the other stacks downloads the compiler binary from the releases page. To also fail on a breaking contract change, add a step with seampact diff --against <baseline>: see Diff.

Set the levels

Set each check to error (fails), warning (reports) or disabled. Put them under checks in seampact.config.yaml.

checks:
  generated: error
  openapi: error
  matrix: warning

generated (default error): a generated file differs from the contract (check.generated.drift).
openapi (default error): an OpenAPI document differs (check.openapi.drift).
matrix (default warning, takes error or warning, not disabled): a framework version seampact has not tested. For the React target it also checks React 19 and the query library the query option picks: TanStack Query 5, SWR 2, or Redux Toolkit 2 with React Redux 9.

Every key: Config reference.

Add seampact to an existing app, or write more of the contract.

Check in CI

Try it locally

Run it in GitHub Actions

Set the levels

Next