Release Mode Functionality

Owned by Arti Sahu
Last updated: Jun 20, 2024
3 min read

Release Mode is a feature that prevents accidental application releases and ensures intentional updates by controlling the state of application versions.

  • It can be enabled in project settings and allows administrators to lock or unlock the release state of application versions.

  • When a version is marked as "Released," it signifies readiness for deployment to mobile devices.

  • This label ensures that when users update their apps, they receive the latest released version, streamlining the update process and maintaining version control.

image-20240423-061002.png

Steps to enable Release Mode functionality:

  1. Click on the Settings button in the top right corner of your project space. Choose ‘Project Settings’; under Project Information on the left side, click ‘Basic’.

  2. Scroll down and mark the tick to the box of Enable Release Mode.

  3. Click the Update Basic Info button at the bottom to save the changes.

Enable Release Mode (1).gif
Steps to Enable Release Mode


If you have the Release Mode setting enabled for your project space, you can see an option to lock or unlock the release mode for your application. By default, the release mode is disabled, meaning all the options associated with each application version are view-only. The state of the application version can't be changed. 

Click on the lock icon. This unlocks the release mode for the application, and you can now change the state of an application version. Mark the required version as Released by clicking the Released button on the build option. 

The main function to be aware of is the Latest Released label. Once an application is marked as Released, it means that when a mobile worker updates the application on their phone, CommCareHQ will send the most recently released version. You should be able to update your phone without re-installing your application with these steps:

  • Make a new version of the application on CommCareHQ

  • Click on Released, and notice that the version that you clicked this on has Latest next to it

  • Update the mobile app (see below)

There are several other actions on this page:

  • View Changes - this button will allow you to see older versions, which are hidden by default.

  • Revert - this will restore your application on CommCareHQ to its state at the time of a version. For example, if you accidentally deleted a module, you can go revert to a version of the application that had the module.

When looking for updates, CommCare apps will look at the latest released build. If an application is already updated to (or was installed with) the newest build, which has been marked as Latest Released, it won't update, even if newer (unreleased) builds have been created. If the latest released build's version is lower than the installed build, an update will not occur. If, for example, the last release was version 70, the currently installed build is version 73 (for testing and development), and there is a newer unreleased build, 74, the app will not attempt to update. If 74 is released, the current build will update the next time it checks.