CI integration

In beta. CI runs use the public-API beta + the CLI — request access.

Add a blocking document check to your pipeline.

GitHub Action

# .github/workflows/preflight.yml — beta: the action ships as a template
# (templates/github-action) you vendor into your repo, e.g. ./.github/actions/preflight
- uses: ./.github/actions/preflight
  with:
    files: "mailing/**/*.pdf"
    fail-on-severity: critical            # default: critical-only
    api-key: ${{ secrets.PREFLIGHT_API_KEY }}

Make the preflight check a required status in branch protection; SARIF output also surfaces findings in GitHub Code Scanning.

GitLab CI

preflight:
  script:
    - preflight ci "mailing/**/*.pdf" --format junit > report.xml
  artifacts:
    reports:
      junit: report.xml

Exit codes — 0 pass · 1 findings at/above fail-on-severity · 2 error.
Defaults to critical-only to minimise day-one CI friction; raise the gate as you adopt.

API reference →