Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
StuartMeeks merged 1 commit into from
May 3, 2026
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,19 @@ services.AddSelfUpdater(opts =>
});
```

> **One-time gotcha when adopting `PreservePaths`.** This option was
> introduced in v0.1.3. The first time a user upgrades *from* a
> pre-0.1.3 build of your CLI *to* a 0.1.3+ build, the swap is
> performed by the **old** binary's update code — which doesn't know
> about `PreservePaths` and will move every file (including the ones
> you intend to preserve) into `.old/`, where they're wiped on the
> next launch. From the *next* update onwards (a 0.1.3+ binary
> upgrading to a newer 0.1.3+ binary), preservation works as
> documented. If your users already have important state in the
> install directory before this change ships, document a one-shot
> manual backup step or have your CLI bootstrap missing files on
> first launch after the upgrade.

Patterns match the **top-level entry name** (the part before the first
`/` in the pattern). `data/**` and `data/seed.json` both preserve the
whole `data/` directory; nested-only preservation isn't supported in
Expand Down