Third Party App Publishing Checklist

The app publishing checklist covers items to review before you publish an app to customers. As with any guidance, if you have a reason to diverge, it is recommended you follow your intuition and do so.

App Checklist

Transition from Applets to Apps

dxapp.json and Source Code

• Conform to Third Party App Style Guide and Community App Guidelines

• In the details field, specify whatsNew and citations.

• In the details field, specify an upstreamProjects key whose value is an array of hashes, each of which describes the licenses associated with software or packages included in this app. This is required to ensure compliance with open-source licenses. For each entry, specify the software's name, repoUrl, version, license, licenseUrl, and optionally author.

• Verify regionalOptions contains regions for ALL supported app regions.

• Set applicable timeout and restart policy in runSpec.

• In the version field, set proper semantic versioning.

• Contemplate setting "openSource": true. The default is False, set at your discretion.

• Add unit tests for your app.

Documentation

• Write Readme.md and (optional) Readme.developer.md.

• Read documentation to double check after building the unpublished app in the Before Publishing the App section. (Unpublished app URL is available to developers as https://platform.dnanexus.com/app/app-xxxx.)

Before Publishing the App

• Build as an app on the DNAnexus Platform billed to org-your_handler (DO NOT PUBLISH YET). Remember unpublished apps can be viewed by developers on the platform under https://platform.dnanexus.com/app/app-xxxx.

• Test it on expected data.

• Verify entity-ids are specified for all supported cloud regions in the app.

• Add Developers via the dx add developers CLI command

• Add org-dnanexus_tools_admin as a Developer so DNAnexus can help add authorizedUsers PUBLIC when needed.

• Add authorized users via the dx add users CLI command

• Contact DNAnexus Support so the DNAnexus tools admin team is notified and can work with you to make the app PUBLIC.

• Publish via the dx publish CLI command

• Verify the versions that appear on the platform are the intended versions

You have published an app. Feel free to publicize your app and let your users know your tool is available in the cloud.