Migration Guide

This guide covers what to change when upgrading pageflare. Breaking changes and required config updates are documented here for each version transition.

General upgrade steps

Regardless of which version you are upgrading to, the process is the same:

Update the CLI binary.

# If installed via npm/pnpm
pnpm add -g pageflare@latest

# If using a pinned binary, download the new release from GitHub

Review the release notes for the target version in Release History.
Check your pageflare.jsonc against the updated configuration reference in the CLI docs.
Run a test build before deploying:
Terminal window
```
pageflare --dry-run
```
Deploy when the dry-run output looks correct.

Version guides

From v1.0.0 to future versions

Migration notes will appear here when a new version is released. Until then, your existing pageflare.jsonc configuration will continue to work as-is.

General tips

Pin your version in CI. Use an exact version rather than a range (pageflare@1.0.0 instead of pageflare@^1) so upgrades are intentional and auditable.
Test on a staging build first. Run pageflare against a local build before rolling a new version to production.
Keep your config in version control. A diff of pageflare.jsonc between commits makes it easy to track configuration changes alongside code changes.
Check the changelog before upgrading. The Changelog page always reflects the current stable release.