Deploy Services

Currently Supported Deploy Services

DeployGate

DeployGate makes it easy to share your in-development iOS and Android apps, allowing developers to seamlessly progress through the prototyping, development, testing, and marketing stages of app distribution.

How to Get API Key

  1. Register and log into DeployGate.

  2. Go to Account Settings.

  3. Then, a Profile page will be shown. You will be able to find the API key at the end of the page.

Parameters

You can use the following parameters in the JSON recipe script for Monaca CI. For more information, please refer to DeployGate API documentation.

Param Description Remark
token Your API key. If you are going to use the API for automated build in your organization, you may want to use organization’s API key which shown on the organization page to upload the app independent from member/role management. Stored in deploy service settings. Automatically populated.
file App file binary Automatically populated
message [Optional] Push message
distribution_key [Optional] Target Distribution Key
release_note [Optional] Distribution message
disable_notify [Optional](iOS only) If you set yes as a value, disable notify via email.
visibility [Optional] Set a new application’s privacy setting by specifying private (default) or public. If you are using Personal Free account, you have to specify public to upload a new app since it doesn’t have a slot for private app. No effect when updating.

HockeyApp

HockeyApp brings mobile DevOps to your apps with beta distribution, crash reporting, user metrics, feedback, and powerful workflow integrations.

How to Get API Key

  1. Register and log into HockeyApp.

  2. Go to Account Settings.

  3. In the Account Settings page, go to API Tokens tab. In this page, you can find all of your API tokens or create a new one. Assuming you haven’t created an API token yet, let’s create one as shown in the screenshot below:

  4. Once the API token is successfully created, you will be able to see it at the bottom of the page.

Parameters

You can use the following parameters in the JSON recipe script for Monaca CI. For more information, please refer to HockeyApp API documentation.

Param Description Remark
ipa File data of the .ipa for iOS, .app.zip for OS X, or .apk file for Android. Automatically populated
dsym [Optional] file data of the .dSYM.zip file (iOS and OS X) or mapping.txt (Android). Please note that the extension has to be .dsym.zip (case-insensitive) for iOS and OS X and the file name has to be mapping.txt for Android.
notes [Optional] release notes as Textile or Markdown (after 5k characters note are truncated)
notes_type [Optional] type of release notes:
  • 0 for Textile
  • 1 for Markdown
notify [Optional] notify testers (can only be set with full-access tokens):
  • 0 to not notify testers
  • 1 to notify all testers that can install this app
  • 2 to notify all testers
status [Optional] download status (can only be set with full-access tokens):
  • 1 to not allow users to download the version
  • 2 to make the version available for download
tags [Optional] restrict download to comma-separated list of tags
teams [Optional] restrict download to comma-separated list of team IDs. For example:
  • teams=12,23,42with 12, 23 and 42 being the database IDs of your teams
users [Optional] restrict download to comma-separated list of user IDs. For example:
  • users=1224,5678with 1224 and 5678 being the database IDs of your users
mandatory [Optional] set version as mandatory:
  • 0 for not mandatory
  • 1 for mandatory
release_type [Optional] set the release type of the app:
  • 0 for beta [default]
  • 1 for store
  • 2 for alpha
  • 3 for enterprise

Appetize.io

Appetize.ios allows you to run Android and iOS apps on your browser. By using this service, it is possible to check the operations of the application without iOS certificates or provisioning profiles.

Let’s try experiencing Appetize.io’s services with this demo.

How to Get API Token

  1. Register and log into Appetize.io.

  2. Enter your email in the Request an API token form and click on Request button to acquire the API token.

Adding the Service to Monaca

After getting the API Token, you are ready to add Appetize.io to Monaca. Please do as follows:

  1. From Monaca Cloud IDE menu, go to Configure → Deploy Services .

  2. Click on Add Deploy Service.

  3. Select AppetizeIo and fill in the required information such as

    • Config Alias: a unique identifier for each service
    • API Token: API Token provided by Appetize.io
  4. Then, click on Add. That’s it. You can now use Appetize’s simulator to install your build apps.

Parameters

You can use the following parameters in the JSON recipe script for Monaca CI. For more information, please refer to Appetize.io documentation.

Parameter Type Description
platform string [Required] Must be ios or android.
timeout number The number of seconds to wait until automatically ending the session due to user inactivity. Must be 30, 60, 90, 120, 180, 300 or 600. (Default is 120)
disableHome boolean Disables the home button on the iOS simulator.
disabled boolean Disables streaming for this app.
useLastFrame boolean Show the last image on the screen in the simulator after session ends.
buttonText string Customize the message prompting the user to start the session. (Default is Tap to play)
postSessionButtonText string Sustomize the message prompting the user to restart the session. (Default is Tap to play)
launchUrl string Specify a deep link to bring your users to a specific location when your app is launched.
note string A note for your own purposes, will appear on your management dashboard.
appPermissions JSON object Values can be authenticated, public, or null to reset to default. Keys can be:
  • run: run your app
  • networkProxy: specify a network proxy when running app
  • networkIntercept: use Appetize.io’s intercepting proxy when running the app
  • debugLog: view your app’s NSLog or Logcat output
  • adbConnect: debug your app by connecting ADB to the hosted emulator
  • androidPackageManager: allow the installation of additional APK’s while your app is running

Upcoming Supported Deploy Services

In addition to the above services, we are planning to add more deployment services. Currently, we are working the following service:

See Also: