Docs Developer Site
Developer Docs Enonic Development Kit 8.x Upgrading Enonic apps

Upgrading Enonic apps

Contents

This page is the entry point for upgrading an Enonic application. Choose the guidance that applies to the application’s current XP version and the version you are targeting.

When building a new Enonic application, use the TypeScript Starter (starter-ts). It provides a project structure and build setup for TypeScript development.

Choosing upgrade notes

  • Coming from XP 7: Follow Upgrading Enonic apps from XP 7 to XP 8. That guide covers the changes needed to reach an XP 8.0 baseline.

  • Already on XP 8: Read the release sections between your current and target versions, in version order. Apply required changes and any guidance for features your application uses. Optional deprecation clean-ups can be done separately.

  • Moving from XP 7 to a later XP 8 release: Combine the XP 7 guide with the subsequent release notes up to your target version. You can apply the changes together and build directly for the target version; an intermediate deployment on XP 8.0 is not required.

The same selection applies when using an AI coding agent: start here, then read the linked guide and release sections that apply to the upgrade.

XP 8.0

XP 8.0 is the baseline for this documentation. The XP 7 migration guide covers changes to the build system, descriptors, application code and APIs when moving from XP 7. There are currently no later minor-release upgrade notes in this stable documentation.

Version bump

Set the platform version in gradle.properties to the release you are targeting. For XP 8.0:

xpVersion = 8.0.0

TypeScript projects also need compatible type definitions. Update the @enonic-types packages used by your application to versions matching the target XP release:

package.json
{
  "devDependencies": {
    "@enonic-types/global": "^8.0.0",
    "@enonic-types/lib-content": "^8.0.0"
  }
}

After applying the relevant upgrade notes and installing the updated dependencies, rebuild and deploy to a sandbox running the target XP version:

enonic project deploy

Verify the application’s behavior in that sandbox before deploying to production.

Contents

Contents