StoryLark
← All guides

Deployment Safety

Use this checklist before an install, engine update, or content-source cutover on a site that already has readers or published content.

Before the change

Rehearsal

  1. Restore the production database and content copy into an isolated deployment.
  2. Configure the repository connection through Admin. Private repositories use a read-only CONTENT_SYNC_TOKEN platform secret; never put it in a file.
  3. Run content validation and the repository dry run. Any error blocks the cutover; validation failures publish nothing.
  4. Run the sync once, compare the complete before/after inventory, then run it again. The second run must write zero chapters and must not change libraryVersion, prose hashes, narration, timings, or voices paths.
  5. Test a multi-chapter book and a standalone story: reading, listening, narrator switching where offered, download/offline use, and saved progress.
  6. Rehearse rollback to the previous Worker and manifest/database state.

Production gate

Deploy only after the rehearsal passes and an operator explicitly approves the production change. Monitor health and the primary read/listen flows for at least 15 minutes. Roll back if content membership changes unexpectedly, an existing account/progress record disappears, narration paths change without a planned re-narration, or the app/health endpoints fail.

Keep the backup and prior automation for at least seven days. Removing either is a separate operator-approved action.


Found a gap? StoryLark is open source — improve these docs on GitHub.