Dev Guide
Dev GuideUser GuideGitHubNuGetDevCommunitySubmit a ticketLog In
GitHubNuGetDevCommunitySubmit a ticket

Version an app

Learn how to manage your app version in Optimizely Connect Platform (OCP), from development to production release.

Optimizely Connect Platform (OCP) uses the following format for app versioning: <app_name>@<app_version>. Where <app_version> consists of the version number and pre-release tag.

For example, if your app name is my_new_marketing_app, your app version is 0.0.0, and you are currently testing the first iteration of your pre-release dev app, your app's version format would look like this: [email protected]

Version number

All OCP apps use the following Semantic Versioning (SemVer) specification. Given a version number MAJOR.MINOR.PATCH, increment:

  1. The MAJOR version when you make an incompatible API change
  2. The MINOR version when you add functionality in a backward-compatible manner
  3. The PATCH version when you make backward-compatible bug fixes

πŸ“˜

Note

When you update your app version, make sure you update all external API call headers.

Upgrading from one MINOR version to another is performed automatically once the new app version is successfully published. For example, if you have published app version 1.0.0 and then publish 1.0.1, the functions onUpgrade and onFinalizeUpgrade in the Lifecycle.ts file are executed automatically for every install on every client account.

However, upgrading from one MAJOR version to another is not performed automatically once the new app version is successfully published. For example, if you have published app version 1.0.0 and then publish 2.0.0, the functions onUpgrade and onFinalizeUpgrade in the Lifecycle.ts file are executed once the client end-user manually clicks Upgrade in the Optimizely Data Platform (ODP) App Directory UI.

Pre-release tag

OCP uses the following pre-release tag, which releases your app to only your private production account.

  • -dev – Versions with a -dev tag are intended for internal testing of your apps, are limited to running in your associated ODP account, are not shareable, and let you bypass the app review process.

Any app with the -dev pre-release tag is not globally visible inside the App Directory and is intended to serve as a work in progress.

Pre-release versioning

Pre-release versioning allows you to work on a single train of code that is consistently named MAJOR.MINOR.PATCH, where you increment the pre-release tag as necessary until you are ready for your production release.

For example, imagine your next OCP app release is 2.1.9. During your development work, you end up with four pre-release dev versions before you are ready for the final release. Your versioning would look like this:

  • 2.1.9-dev.1 – Your first pre-release version
  • 2.1.9_dev.2 – Your second pre-release version
  • 2.1.9_dev.3 – Your third pre-release version
  • 2.1.9_dev.4 – Your fourth pre-release version
  • 2.1.9 - Your release version

The pre-release tag and versioning allows you to modify your release without incrementing the MAJOR, MINOR, or PATCH numbers. That way, your release version remains consistent while you work on your code, only incrementing the pre-release tag as you work.

Update your pre-release app version

To update your pre-release dev app version:

  1. Update the version field in the app.yml file for your app on your local machine. Increment the pre-release dev version by 1 and save your changes. For example, if your current pre-release dev version is 0.0.0-dev.1, update it to 0.0.0-dev.2.
  1. In the OCP CLI, run the following command to validate, package, upload, and build your new pre-release dev app version:

    opti app prepare <path>
    
  2. Once complete, publish your new pre-release dev app version. In this example, <appVersion> is [email protected]:

    opti directory publish <appVersion>
    
  3. Your app running in your personal ODP production account is automatically upgraded to the new app version. You can see this by navigating to the App Directory and clicking the app tile. The current version of your app displays:

General availability (GA) release versioning

When you are finished testing your app and are ready to release it to GA, you enter the app review process. Your app is approved as either a beta app, private app, or released app:

  • Beta apps – Use the -beta release tag to release your app as a beta. Versions with a -beta suffix can only be installed using an app beta share link (for example, https://get.optimizely.app/{{app}}?v=1.0.0-beta).
  • Private apps – Apps that are released to production, but their availability in the OCP App Directory is limited to one or more accounts.
  • Released apps – Apps released to production are generally and publicly available in the OCP App Directory.

Update your GA app version

To update your app version and publish to production:

  1. Update the version field in the app.yml file for your app on your local machine. Remove the pre-release tag and save your changes. For example, if your current pre-release dev version is 0.0.0-dev.1, update it to 0.0.0.
  1. In the OCP CLI, run the following command to validate, package, upload, and build your new production app version:

    opti app prepare <path>
    
  2. Once complete, publish your new production app version. In this example, <appVersion> is [email protected]:

    opti directory publish <appVersion>
    
  3. Your app running in your personal ODP production account is automatically upgraded to the new app version. You can see this by navigating to the App Directory and clicking the app tile. The current version of your app displays:

Example of valid app versions:

1.0.0
0.0.1-dev.1
1.0.0-beta.2
1.2.3-private

Example of invalid app versions:

VersionReason
1.0Version number only includes a MAJOR and MINOR number, but is missing the required PATCH number
1.2.3.4Version number includes 5 numbers separated by periods, which is not a valid semantic version
1.002.3Version MINOR number has leading zero
1.2.3-dev.01Version pre-release tag has leading zero
1.2.3-internalVersion pre-release tag is invalid, only dev, beta and private are supported
1.2.3-Version number includes a hyphen followed by nothing, which is not a valid pre-release identifier
1.2.3-beta-2Pre-release version is followed by hyphen instead of dot