docs: --since Django format, exit codes, hero section, comparison table, demo GIF#60
Merged
Conversation
- docs/cli.md: expand --since section with Django app_label.migration_name format, directory structure example, behavior on no-match (exit 1), and note that graph checks are skipped in --since mode; fix mrt version example output (1.3.0 -> 1.3.1) - README.md: add graph-check skip note and link to full CLI reference; clarify Django format comment (filename without .py) - CHANGELOG.md: fix 1.3.0 entry -- --since takes a migration revision ID, not a git ref; remove incorrect examples (--since main, HEAD~3) Closes #39
Exit code 1 means warnings only (without --strict); exit code 2 means errors found or warnings with --strict. All three files had this wrong (docs/cli.md, docs/quickstart.md, docs/faq.md), which would cause CI pipelines relying on the documented codes to behave incorrectly. Also remove a duplicate interface description paragraph in cli.md.
Hero section: add mrt check output example showing what would have been caught, and "non-invasive" install note to reduce adoption friction. Add "How it compares" table covering pytest-alembic, alembic check, and django-test-migrations — highlighting data survival check as the key differentiator. Add demo.tape for VHS GIF generation (vhs demo.tape once installed).
Generated with VHS (demo.tape). Shows mrt check catching DROP COLUMN data loss and No-op downgrade on example migrations, with colored error/warning output and summary line.
croc100
force-pushed
the
docs/update-v1.3.1
branch
from
bc55829 to
9d0d316
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
--sinceDjango format in CLI reference:app_label.migration_nameexplained with directory structure example, no-match behavior (exit 1), graph-check skip note1=errorswas wrong in cli.md, quickstart.md, faq.md; correct values are0/1/2--sincewas described as accepting git refs (--since main,HEAD~3); it takes migration revision IDsmrt checkoutput example showing what would have been caught; add "non-invasive" install notemrt checkcatching DROP COLUMN and No-op downgradeFiles changed
docs/cli.md— --since section expanded, exit code table fixed, duplicate paragraph removed, version example updateddocs/quickstart.md— exit code table fixeddocs/faq.md— exit code heading fixedCHANGELOG.md— --since description correctedREADME.md— hero section, comparison table, demo GIF embeddeddocs/demo.gif— newdemo.tape— VHS script for reproducing the GIF