Skip to content

1.0: freeze the .fwincident schema and commit to forward migration #351

Open

Description

@DeepDiver1975

Every incident lives in one .fwincident SQLite file. The README tells users
plainly that the format can still change between versions before 1.0. That
warning is the single biggest reason a Wehr would hesitate to run Lagebuch on a
real Einsatz rather than an Übung.

Version 1.0 means retiring that warning. This issue tracks what has to be true
first.

The mechanism that already exists

  • src/LageBuch.Persistence/Sqlite/Migrations.cs carries CurrentVersion and
    migrates older files forward on open.
  • UnsupportedSchemaVersionException rejects a file written by a newer version
    with a clear message instead of corrupting it.

So the machinery is in place. What is missing is the commitment.

What 1.0 requires

  • A written compatibility guarantee. A file written by 1.x opens in every
    later 1.x. State it in README.md and in docs/, in German, because the
    audience for the promise is the Kommandant, not the developer.
  • Migration tests as a standing gate. A fixture file per historical schema
    version, checked into the repo, with a test that opens each one and asserts
    the migrated result. Today's coverage tests the migration code; this tests the
    actual old files.
  • A schema review before the freeze. One deliberate pass asking what we
    would regret. After 1.0 a mistake costs a migration forever.
  • A documented forward-compatibility story. What a 1.0 build does with a file
    from 1.4. Today it refuses with a message, which is defensible, but it should
    be a stated rule rather than an implementation detail.
  • Export as the escape hatch. PDF export already exists. Confirm it is
    complete enough that a user is never trapped in the format.

Not in scope

Feature work. 1.0 is a promise about the file, not a feature set.

Discussion welcome. This is the milestone that turns Lagebuch from something a
Wehr tries into something a Wehr relies on.


New here?

Comment to claim this issue and it is yours. If no pull request appears within
seven days it goes back in the pool, no hard feelings.

Before you open the PR, please skim CONTRIBUTING.md:
commits need DCO sign-off (git commit -s) and a Conventional Commit subject.
Changes under src/ additionally need an entry under ## [Unreleased] in
CHANGELOG.md — CI fails the PR otherwise.

Questions are welcome right here or in
Discussions.

Activity

  1. DeepDiver1975 commented on Oct 1, 2026

    @DeepDiver1975
    ContributorAuthor

    Freeze-contract item from #337 (#549): an .fwincident stores the Stammdaten values it uses, never references into masterdata.db, and carries no md_* tables. A file must render identically whatever the local Stammdaten hold.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requesthelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions