Skip to main content

rt settings schema diff

rt › settings › schema › diff

Classify every schema change since a previous lock as safe or breaking; exits 1 unless a breaking change has a storeVersion bump and a matching migrateFrom entry (a never-shipped key may instead be acknowledged)

Usage​

rt settings schema diff [flags]

Arguments & flags​

Flag / ArgTypeDefaultDescription
--againsttextDiff against a lock file; a missing file counts as no lock
--against-reftextDiff against the committed lock at a git ref (default origin/main); a ref with no lock counts as no lock
--shipped-reftextThe release whose lock says which keys have shipped (default: the highest v* tag); only a key absent there may take a breaking change on an acknowledgement
--draftbooleanfalseWrite a migrateFrom entry (or a rename) for each breaking change into the migration files, for review
--jsonbooleanfalseMachine-readable output

See code: commands/settings-schema.ts › settingsSchemaDiff