Skip to main content

Migrate v1 to v2

||

Migrate an existing Showpad App to take advantage of the v2 manifest and extension types.

What you'll learn:

  • How to restructure your v1 app's resources into an extension folder
  • How to update your manifest to the v2 format and map your v1 appId to the v2 appKey

1. Move Resources​

The first step is to move all of your app's resources to a separate folder (e.g., experience) and leave the manifest in the app's root folder.

/experience/index.html
/experience/config.json
/experience/some-file.txt
/experience/other/some-file.png
/manifest.json

2. Migrate Manifest​

Update your manifest to the v2 format and define an Experience type extension.

Use the v1 appId as the v2 appKey and Experience type's extensionKey. If your new app includes multiple Experience types, this makes it easy to identify the correct Experience type.

Use the new folder (created in Step 1) as the Resources folder.

{
  "$schema": "https://schema.showpad.com/app/manifest.v2.json",
  "schema": {
    "type": "app-manifest",
    "version": 2
  },
  "appKey": "com.showpad.app.upgrade",
  "name": "Upgrade v1 - v2 test",
  "version": "1.0.1",
  "description": {
    "short": "Upgrade v1 - v2 test",
    "full": "Testing upgrade from apps-v1 to apps-v2"
  },
  "images": [],
  "developer": {
    "name": "Showpad",
    "websiteUrl": "https://showpad.com"
  },
  "experienceTypes": [
    {
      "extensionKey": "com.showpad.app.upgrade",
      "name": "Test Upgrade Experience",
      "description": "An upgrade test",
      "resources": {
        "folder": "experience"
      }
    }
  ]
}

3. Upgrade App​

Upgrade the app by creating a new Showpad Bundle and uploading it to Showpad. Be sure to use the original appId.

Next Steps​

Was this page helpful?