SIS CLI

Migration Notes Guide

This guide explains when operators and automation must consult migration notes.

When updates are required

Update migration notes for any operator-visible or automation-visible change, including:

  • CLI flag additions/removals/behaviour changes
  • report/schema field changes
  • verdict or score routing behaviour changes
  • runtime artefact shape changes
  • output contract changes for query/report/error surfaces

Practical workflow

  1. Make code and test changes.
  2. Capture behavioural and artefact drift evidence.
  3. Update docs/migrations.md with concrete before/after notes.
  4. Record required downstream action for consumers.

Required detail level

Each migration entry should include:

  • exact affected command/surface
  • old versus new behaviour
  • compatibility impact
  • any remediation or rollout sequence

Recent entries

2026-05-31 — PDF surface separation

  • sis repl <pdf> is deprecated; use sis pdf repl <pdf>.
  • sis generate mutate and sis generate redteam are deprecated; use sis pdf generate mutate and sis pdf generate redteam.
  • Shared input file-size security events use the input.gate domain instead of the PDF-specific pdf.structure domain.
  • Scan/query JSON payloads are unchanged; deprecated aliases remain functional and warn on stderr.
  • sis docs verdict
  • ../migrations.md