Skip to content

Commit f7f3cc4

Browse files
committed
docs(changelog): require a database backup before the payments migration
The unreleased work includes migration 00072, which renames two columns on `bookings` and adds `payment_provider`. Migrations run automatically at boot, so an operator only learns about it when the app starts the new image. Records it in the `[Unreleased]` section, which is what becomes the release body, so the instruction cannot be missed at the one moment it matters. Covers both deployment paths: the Litestream drill for Docker and Railway (including the `calnode.key` caveat, since the replica holds the database and not the key), and a module backup for NS8, which captures the volume and `state/calnode.env` where the key lives. No code change.
1 parent 0c181ff commit f7f3cc4

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,25 @@ exact tag (`ghcr.io/calnode/calnode:0.1.0`) if you need stability between upgrad
1111

1212
## [Unreleased]
1313

14+
### Upgrading
15+
16+
- **Back up the database before upgrading.** This release includes a migration (`00072`)
17+
that renames two columns on `bookings` and adds one. Migrations run automatically at
18+
boot, so the upgrade is the moment to want a restore point that predates it.
19+
20+
- **Docker or Railway.** Take the backup deliberately rather than assuming a replica
21+
exists somewhere, and prove it restores while the app is still on the old version: the
22+
non-destructive drill in `DEPLOY.md` §6 restores to a scratch path without touching the
23+
live database. If you run without `CALNODE_ENCRYPTION_KEY`, also copy
24+
`/data/calnode.key`. The replica holds the database, not the key, and a restore without
25+
it will not start.
26+
- **NS8 module.** Run a module backup before pulling the new image. It captures
27+
`volumes/calnode-data` and `state/calnode.env`, which is where the encryption key lives.
28+
29+
The migration has a down path that restores both column names and keeps the data, but a
30+
backup is the only safety net for anything that goes wrong between the migration running
31+
and your first check that existing bookings still look right.
32+
1433
### Added
1534

1635
- **German without du or Sie (`de-x-neutral`).** An opt-in wording variant of the German

0 commit comments

Comments
 (0)