Publish the app in OCP App Directory

Before publishing your app to the OPTIHUB App Directory, you must first:

• Complete the prerequisites
• Scaffold the app and define the schema
• Publish to the OPTIHUB sandbox
• Configure and authenticate the app using an app settings form
• Write a function that subscribes to events and interacts with OPTIHUB APIs
• Write a job that processes data from an Azure storage account and imports it into OPTIHUB

Explain the version of the app you've been working with up till now, and generally how versioning works. If this hasn't changed, we can just reuse this exactly as is. Mainly, is there still a required app review process? For example:

Throughout this quickstart guide, you have been working with the -dev tagged version of the app. This version is designed for internal testing and development of apps. When you finish developing your app and want to make it available to OPTIHUB customers, you need to change your app version in the app.yml file to a non-dev version. You have the following three version options:

• Full release version – A version without any tag, for example, 1.0.0. This version is published to the OPTIHUB App Directory and is available to all OPTIHUB customers.
• Beta version – A version with a beta tag, for example, 1.0.0-beta.1. This version is not visible in the OPTIHUB App Directory by default. Customers must have a special link to install it, which you can get from Optimizely support. For beta apps, you decide which customers can access your app.
• Private version – A version with a private tag, for example, 1.0.0-private. As with beta versions, this version is not visible in the OPTIHUB App Directory. Customers must have a special link to install it, which you can get from Optimizely support. For private apps, you decide which customers can access your app.

Before you can publish a non-dev app for OPTIHUB customers to install, Optimizely must review and verify the app and its code in the App Review Process. Optimizely engineers will check your app for security vulnerabilities, performance issues, and compliance with the permitted use of the platform. For more information on the App Review Process, see Submit an app for review.

Publish the app to OPTIHUB App Directory

Explain how to publish app to App Directory by changing the version. Provide yml with the app version info. Provide the CLI command to prepare the app, including any prompts the CLI returns that they need to interact with. For example:

To publish your app to the OPTIHUB App Directory, change the version of your app in the app.yml file to a non-dev version. For this sample app, use a full-release version (1.0.0):

meta:
  app_id: ocp_quickstart
  display_name: OCP Quickstart
  version: 1.0.0

Next, run the following command in the OPTIHUB command-line interface (CLI):

$ ocp app prepare

The OPTIHUB CLI displays the following prompt to confirm that you want to send the app to the App Review Process. When you confirm, the app is built and sent to the Optimizely App Review team.

The app version is already in review. This will update the review and the app can't be published until it is approved. Are you sure?
Existing version not found...
Performing local validation...
...
Waiting for build (id=2759) to complete... CTRL+C to stop checking.
Build complete.

Your app has been sent to review. Your code will be available in a private repository on GitHub, and you will receive an invitation from GitHub by email for access. It is important you accept this invitation in order to receive communications about your app from the review team.

Once the review is approved, your app can be deployed to app directory.

You can run ocp review open [email protected] to open the review URL at any time.
The URL for your repo is https://github.com/Optimizely-Connect-Platform-AppReview/ocp_quickstart_1.0.0/pull/1

App Review Process

Is there still a required app review process for OPTIHUB? If so, we can probably keep this as is. If not, adjust this page to account for the new publishing process without app review as a step. For example:

📘

Note

The App Review Process typically takes one to two business days to complete.

The Optimizely App Review team invites you to a GitHub repository with the app code. When you accept the invitation, you can see the pull request and feedback from Optimizely engineers as they review your code.

📘

Note

GitHub notifies you by email about any activity on your app review's GitHub repository.

If Optimizely determines that changes are required, Optimizely submits a GitHub pull request. After you make the requested changes, run ocp app prepare in the OPTIHUB CLI again with the same version. This updates the pull request with the latest code from your app.

When the Optimizely engineers approve your app review, you can publish your app by running the following command in the OPTIHUB CLI:

ocp directory publish [email protected]

Now, your app is available in the OPTIHUB App Directory for all Optimizely customers.