HomeGuidesAPI ReferenceGraphQL
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

Publish your first OCP application

This will walk you through a private publication of your first app to the Optimizely Connect Platform (OCP) App Directory.

Release a private version of your app

As a developer on the OCP platform, you are limited to a release of apps ONLY to your private account. Publication for general consumption is covered later in the documentation.

This section will walk you through the release of your new app to your instance of the App Directory.

1. Get your trackerID

Run the command opti accounts whoami to retrieve your trackerID. This is the ID of your ODP account and the OCP App Directory.

2. Build a Git repository

Change directories into the working directory for your app. Verify that your machine has git installed on your machine. Run git init to create a Git repository:

3. Run yarn build

Run yarn build in your working directory, which converts content to TypeScript.

4. Validate your app

Run opti app validate to have your build validated locally.

5. Register your app

You will need the app ID and app display name for this step. You can find them in the app.yml file in your working directory.

Contents from the app.yml fileContents from the app.yml file

Contents from the app.yml file

Run opti app register [--id=<id>] [--name=<name>] where id=app_id and name=display_name:

6. Upload your app

Upload your app to OCP using opti app upload from the working directory:

7. Publish your app

Use the command at the bottom of the last step, opti directory publish <app_id>@<version>:

8. Install your app

Use opti directory install <appVersion> <trackerId> to install your app in your private instance of the App Directory. AppVersion is the App ID plus the version number (for example, [email protected]) and the trackerID was retrieved in the first step.

9. Viewing your app in the App Directory

Open your ODP instance. Navigate to the App Directory:

The apps are listed in alphabetical order. Scroll until you find your app:

10. Clean up the environment

Unpublish your app when complete to help us maintain a clean and tidy production environment. Run opti directory unpublish <appVersion> to uninstall and unpublish your app.