Upgrade Unchained Engine
Instructions
- Enter planning mode to create an upgrade plan
- Get available versions with
npm view @unchainedshop/platform versions --json
- Show the user which versions they can upgrade to
- Once a target version is selected (e.g.,
4.5.0), fetch these resources:
- Migration guide:
https://raw.githubusercontent.com/unchainedshop/unchained/refs/tags/v{version}/MIGRATION.md
- Changelog:
https://raw.githubusercontent.com/unchainedshop/unchained/refs/tags/v{version}/CHANGELOG.md
- README:
https://raw.githubusercontent.com/unchainedshop/unchained/refs/tags/v{version}/README.md
- Execute the upgrade by:
- Updating npm dependencies
- Removing deprecated dependencies
- Running lint, tests, and build
- Starting the project to verify
Reference Examples
Fetch example boot files for the target version to understand current patterns:
| Framework |
Example URL |
| Express |
https://raw.githubusercontent.com/unchainedshop/unchained/refs/tags/v{version}/examples/kitchensink-express/src/boot.ts |
| Fastify |
https://raw.githubusercontent.com/unchainedshop/unchained/refs/tags/v{version}/examples/kitchensink/src/boot.ts |
| Minimal |
https://raw.githubusercontent.com/unchainedshop/unchained/refs/tags/v{version}/examples/minimal/boot.js |
| Ticketing |
https://raw.githubusercontent.com/unchainedshop/unchained/refs/tags/v{version}/examples/ticketing/boot.ts |
| OIDC |
https://raw.githubusercontent.com/unchainedshop/unchained/refs/tags/v{version}/examples/oidc/boot.ts |
If an example URL returns 404, list https://api.github.com/repos/unchainedshop/unchained/contents/examples?ref=v{version} and use the boot file found there.
Feature Guides
Fetch these when the project uses the feature:
| Feature |
Guide URL |
Ticketing (@unchainedshop/ticketing) |
https://raw.githubusercontent.com/unchainedshop/unchained/refs/tags/v{version}/docs/docs/guides/ticketing-setup.md |
| Ticket renderers (PDF, Apple Wallet, Google Wallet) |
https://raw.githubusercontent.com/unchainedshop/unchained/refs/tags/v{version}/docs/docs/guides/ticketing-renderers.md |
Additional Resources
