The README describes an upgrade path that does not exist before 1.0 #520

Closed
opened 2026-10-13 06:34:37 +02:00 by clawbot · 1 comment
Collaborator

Severity: medium (the README promises behaviour the code does not have).

Since #519, each database's schema comes from 001_schema.sql, which is edited in place before 1.0. A newer binary therefore changes nothing in a database file an older one created. The README still describes an upgrade path:

  • "Upgrades" (under "Backup, Restore, and Upgrades"): the upgrade procedure, "There are no down migrations", "Once a newer binary has migrated the files…", and the note on upgrading past the introduction of BIND_ADDRESS.
  • Elsewhere: sentences about what an older version or older build wrote, and what upgrading to a build does to existing sessions (around "Sessions", the backup section, and the webhook retention text).

webhooker is pre-1.0 and has no installed base, so the README should not describe upgrades, older versions' data or compatibility at all.

Done when:

  • No README sentence describes upgrading, migrating existing files, an older version's data, downgrade, or compatibility with an earlier build.
  • What is still true and useful stays: the description of the SQL schema files moves to the database architecture section; checking the running version through the health check stays under "Version stamping"; backup and restore stay as they are.
  • Every changed sentence is true against the code. Docs-only, one PR to next.

Model: opus-5-5

Severity: medium (the README promises behaviour the code does not have). Since https://git.eeqj.de/sneak/webhooker/pulls/519, each database's schema comes from `001_schema.sql`, which is edited in place before 1.0. A newer binary therefore changes nothing in a database file an older one created. The README still describes an upgrade path: - "Upgrades" (under "Backup, Restore, and Upgrades"): the upgrade procedure, "There are no down migrations", "Once a newer binary has migrated the files…", and the note on upgrading past the introduction of `BIND_ADDRESS`. - Elsewhere: sentences about what an older version or older build wrote, and what upgrading to a build does to existing sessions (around "Sessions", the backup section, and the webhook retention text). webhooker is pre-1.0 and has no installed base, so the README should not describe upgrades, older versions' data or compatibility at all. Done when: - No README sentence describes upgrading, migrating existing files, an older version's data, downgrade, or compatibility with an earlier build. - What is still true and useful stays: the description of the SQL schema files moves to the database architecture section; checking the running version through the health check stays under "Version stamping"; backup and restore stay as they are. - Every changed sentence is true against the code. Docs-only, one PR to `next`. Model: opus-5-5
clawbot self-assigned this 2026-10-13 06:34:37 +02:00
Author
Collaborator

#521 removes the Upgrades section and every other README sentence about upgrading, downgrading or data an older build wrote. The description of the SQL schema files moves to a new Schema subsection under Database Architecture, and the health check command moves into Version stamping.

Model: opus-5-5

https://git.eeqj.de/sneak/webhooker/pulls/521 removes the Upgrades section and every other README sentence about upgrading, downgrading or data an older build wrote. The description of the SQL schema files moves to a new Schema subsection under Database Architecture, and the health check command moves into Version stamping. Model: opus-5-5
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/webhooker#520