All Products
Search

This Product

    Mobile Platform as a Service:Manage iOS releases

    Document Center

    Mobile Platform as a Service:Manage iOS releases

    Last Updated:Jul 12, 2023

    Release management is the configuration backend for upgrading the client to a new version, which allows you to create multi-task and multi-dimensional upgrade configuration.

    About this task

    iOS release management provides the following functions:

    • Add upgrade resources and provide the QR code (for Enterprise distribution only) for downloading the app .

    • Create and modify the task of the new version resource package.

    • Create multiple types of release tasks for added release packages, such as whitelist gray release, time-window gray release, and official release. One upgrade package can have multiple release tasks.

    • Support upgrade filtering by multiple criteria, such as the city, model, device system version, network, and release package version.

    Add release packages

    Log in to the mPaaS console and perform the following steps:

    1. In the left navigation bar, choose Mobile Delivery Service > Release management. The release management list is displayed.

    2. Click Add a package, and complete the following configuration in the pop-up window:

      • Platform: Select iOS.

      • Release type: The options include App Store, Enterprise distribution, and TestFlight.

        • App Store: Upgrade prompts for apps downloaded from the App Store will be displayed.

        • Enterprise distribution: Upgrade prompts for apps distributed within enterprises will be displayed.

        • TestFlight: Gray release verification will be performed on a new version before its release in the App Store.

    3. Click OK. The new release package is displayed on the top of the list.

    4. In the release management list, click the plus icon (add) in front of the release package to view the release task of the upgrade package:

      • If the upgrade package has never been released, the status of the package is To be released, and there is no release task.

      • If the upgrade package has been released, the status of the package is the release status of the latest task, and there are release tasks.

    App Store

    Note

    To use App Store release, first launch your App in the App Store.

    If you select App Store, you should provide the following information:

    • App Store address: Enter the address of your App in the App Store.

    • Version: Enter the version number of current release.

      Note: The version number must keep consistent with the Product Version in info.plist file in the iOS project.

    • Release description: Describe this release. Optional.

    Enterprise distribution

    If you select Enterprise distribution, you should provide the following information:

    • Upload icon(optional): Upload a picture in the .jpg or .png format. Optional.

    • Package: Upload a local .ipa release package.

    • bundleId(optional): App bundleId. If left empty, the bundleId you entered in the the bundleId you entered on the code configuration page when downloading the configuration file will be used.

    • Version: Enter the version number of this release.

      Note: The version number must keep consistent with the Product Version in info.plist file in the iOS project.

    • Release description(optional): Describe this release. Optional.

    • Download verification: When enabled, after the QR code is scanned, the package can be downloaded only after the verification code is verified.

      Note

      After the Enterprise distribution release package is added, a QR code is generated in the QR code column in the release management list for users to download the .ipa release package.

    TestFlight

      Note

      To use TestFlight testing features, you must have created and enabled public links in App Store Connect.

      TestFlight is only available in clients with version ≥ 10.1.32.

      The Package Expiration Time and Tester Limit you enter must match what you set in App Store Connect.

    If you select TestFlight, provide the following information:

    • App Store Connect address: Enter the public link address that you have created on App Store Connect. Ensure that the link is enabled.

    • Valid days: Enter the number of valid days of the TestFlight package. It must be consistent with that you have set on App Store Connect.

    • Tester limit: Enter the maximum number of persons involved in the test. It must be consistent with that you have set on App Store Connect.

    • Version: Enter the version number of this release.

      Note: The version number must keep consistent with the Product Version in info.plist file in the iOS project.

    • Release description: Describe this release. Optional.

    Create a release task

    Create a release task for the added release package. Multiple release tasks are supported for one upgrade package. Up to 10 release tasks are allowed for one upgrade package concurrently.

    Rules for delivering release tasks:

    • When the client request matches multiple tasks, the higher version task takes priority.

    • If a release package have multiple release tasks, by task type, the priority of the tasks is: Formal release > Whitelist gray release > Time window gray release.

    • For a specific version release package, if the task type of the release tasks are same, the latest released task shall prevail.

      For example, for version 5.0 upgrade package, a whitelist release task A was created on the console to perform upgrade for version 4.0 app with single reminder; then a whitelist task B was created to perform a forced upgrade for version 4.0. With the two tasks performing at the same time, when a 4.0 version client requests an upgrade, task B is delivered first, and after task B is terminated or suspended, task A takes effect.

    • If a grayscale task and a formal task are performed concurrently for a release package, the release status shows "Official release" in the release task list, and when the formal task is paused or ended, the release status changes to "Gray release". If all tasks are finished, it shows "Finished".

    The operation steps are as follows:

    1. Locate the release package for which you want to create a release task.

    2. In the Operation column, click Create release task.

    3. On the Create a release task page, select or enter the following information:

      • Release type: You can select Gray release and Official release.

        • Gray release: Before the official release, release the package to some of the users to test and validate the functionality of the new package.

        • Official release: Release the package officially to all the users.

          Note

          TestFlight and enterprise distribution types of distributions only support gray release. The TestFlight release page does not display the release type option, and the release package of the enterprise distribution type is fixed to the gray type and cannot be selected.

      • Upgrade mode: You can select Single, Multiple, and Forced upgrade.

        • Single: After the App is started, it displays an upgrade message based on the silent strategy.

          Note

          Silent strategy means that the reminder will be in silent state for a period of time, and no longer reminds the upgrade after the user cancelled the pop-up upgrade reminder. The default silent period is 3 days, which can be customized. To customize the silent period, see Release a new version.

        • Multiple: The App displays an upgrade message every time it is started.

        • Forced upgrade: The App displays an upgrade message each time it is started. You cannot close the message window.

          Note

          For TestFlight release packages, only Single and Multiple are available.

      • Release model (only when Gray release is selected): You can select Whitelist gray release and Time-window gray release.

        • If you select Whitelist gray release, you can configure a whitelist below.

          Note

          You can configure a whitelist on the Whitelist management page. For more information, see Manage whitelist.

        • If you select Time-window gray release, you can specify End time and Users count.

          Note

          For Enterprise distribution release packages, only Whitelist gray release is available.

      • Upgrade prompt message: Specify a message to be displayed upon an upgrade. Optional.

      • Release description: Describe this release. Optional.

      • Advanced rule: For Gray release only. Click Add. In the displayed dialog box, select a rule type such as City, Device model, or Network in Type, set Operation type to Include or Exclude, and set Resource value corresponding to the type you selected.

    4. After completing the configuration, click OK. To view the release task that you have created, click the plus icon (add) on the left of the release package.

    Other operations

    • Upload symbol table. In the release management list, upload a symbol table to an added release package.

      • One .ipa release package corresponds to one symbol table file.

      • Only symbol tables in the dSYM format are supported. Before uploading a symbol table, compress it into a .tgz package.

    • Change the release task of an upgrade package. Click the plus icon (add) in front of the release package in the release management list to view the release task of the upgrade package.

      • Click Pause to suspend the release task. To continue the task, click Continue.

      • Click End to terminate the release task. After the task is terminated, you can no longer operate it.