Skip to content

docs: callout the one-time gotcha when adopting PreservePaths#7

Merged
StuartMeeks merged 1 commit intomainfrom
preservepaths-migration-note
May 3, 2026
Merged

docs: callout the one-time gotcha when adopting PreservePaths#7
StuartMeeks merged 1 commit intomainfrom
preservepaths-migration-note

Conversation

@StuartMeeks
Copy link
Copy Markdown
Owner

@StuartMeeks StuartMeeks commented May 3, 2026

Summary

Adds a short blockquote callout in the "Preserving user files across updates" README section, spelling out the chicken-and-egg gotcha when a consumer first turns on PreservePaths:

The first upgrade onto the new build is performed by the old binary's update code, which doesn't know about PreservePaths and moves everything into .old/. From the next update onwards (0.1.3+ → 0.1.3+), preservation works as documented.

Suggests two practical mitigations: ask users to back up state once before the upgrade, or have the CLI bootstrap missing files on first launch after the upgrade.

Docs-only — no version bump, no behaviour change.

Test plan

  • README renders correctly
  • CI green (unchanged from main since this is docs-only)

🤖 Generated with Claude Code

A consumer hit it: switched their CLI from a pre-PreservePaths
build to one configured with PreservePaths, expected the user's
appsettings.Development.json to survive the upgrade, lost it.

The cause is generic to self-updaters: the *first* upgrade onto
the new version is performed by the *old* binary's update code,
which doesn't know about PreservePaths and moves everything into
.old/. From the next update onwards, preservation works as
documented.

Adds a short blockquote callout in the "Preserving user files"
README section spelling this out, plus a hint to either ask users
to back up state once or have the CLI bootstrap missing files on
first launch after the upgrade.

Docs-only — no version bump, no behaviour change.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@StuartMeeks StuartMeeks merged commit e0418bf into main May 3, 2026
4 checks passed
@StuartMeeks StuartMeeks deleted the preservepaths-migration-note branch May 3, 2026 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant