Document drift command marks #57

Activity

1. sevdog

   added

   enhancementNew feature or requestNew feature or request

   on Jul 29, 2026
2. FROWNINGdev

   added 2 commits that reference this issue on Jul 29, 2026

   drift: document the !! and ~ marks where they are printed

   ...

   ecc75dd

   readme: roadmap entry for the py-1.7 to 1.8 wave

   ...

   e0d611b
3. FROWNINGdev commented on Jul 29, 2026

   

   FROWNINGdev

   on Jul 29, 2026

   Owner

   More actions

   Good catch, and thanks for linking the exact line — you were right that the source was the only place the marks were explained.

   Fixed in ecc75dd. You asked for the help text or the output; it went into both, because the marks appear in the output but people look for meaning in --help:

   $ django-orm-lens drift
   !! blocking — models declare something no migration creates; it will not exist at runtime
    ~ advisory — migrations keep something models no longer declare; harmless at runtime
   
   !! blog.post:
        declared but never migrated: author
          the column will be missing at runtime
   
   summary: 1 model(s) drifted, 1 blocking, 2 migration(s) replayed
   

   drift --help now prints the same two lines plus the rule that follows from them — only blocking drift fails the build, --exit-zero reports it without the non-zero exit.

   Two details you may care about, since you maintain a migration-check Action yourself:

   • The legend is a module constant next to the marks, imported by the CLI rather than retyped. A second copy in the argument parser is exactly how these went undocumented in the first place, and it would rot the same way. The tests assert the legend against the mark each entry actually carries, not against a hardcoded string.
   • No legend on a clean run — nothing is marked there — and JSON output is unchanged, since it always carried "blocking": true | false outright.

   On main now, ships in the next release. Credited you in the changelog and the roadmap.

   👍React with 👍1Reacted by Devid
4. FROWNINGdev

   closed this as completedon Jul 29, 2026