Update to a new version or branch

Build yourself instead of download

AAPS is not available to download, due to regulations concerning medical devices. It is legal to build the app for your own use, but you must not give a copy to others! See FAQ page for details.

Important notes

  • Please update to the new version of AAPS as soon as possible after a new release is available.

  • When a new release is available, in the AAPS app itself, you will receive an information banner about the new version.

  • The new version will also be announced on Facebook at the time of release.

  • Following the release, please read the Release Notes in detail, and clarify any queries with the community on Facebook or Discord, before proceeding with the update.

    Note

    In case you want to build AAPS on a new computer : copy your back-up keystore file to the new computer. Then follow the Initial build AAPS procedure instead of this guide. With the only difference that instead of creating a new keystore, you can select the one you have copied on the new computer.

Overview for updating to a new version of AAPS

In case you experience problems, see separate page for troubleshooting Android Studio.

Export your settings

Export your settings from the existing AAPS version on your phone. You might not need it, but better be safe than sorry.

See the Export & import settings page if you don’t remember how to do this.

Check your Android Studio version

The minimal version required is described in the Building Instructions. If your version is older, please update Android Studio first!

Update your local copy

WARNING

If you update from versions prior to 2.8.x, please follow the instructions to do a New clone, as this guide will not work for you!

  • Open your existing AAPS project with Android Studio. You might need to select your project. (Double) click on the AAPS project.

    Android Studio - Select Project

  • In the menu bar of Android Studio, select Git -> Fetch

    Android Studio Menu - Git - Fetch

  • You will see a message in the lower right corner that Fetch was successful.

    Android Studio Menu - Git - Fetch successful

  • In the menu bar, now select Git -> Pull

    Android Studio Menu - Git - Pull

  • Leave all options as they are (origin/master) and select Pull

    Android Studio - Git - Pull dialog

  • Wait while download is in progress, you will see this as info in the bottom bar. When it’s done, you will see a success message.

    Note

    The files that were updated may vary! This is not an indication

    Android Studio - Pull successful

  • Gradle Sync will be running to download some dependencies. Wait until it is finished.

    Android Studio - Gradle Sync

Check JVM version

This check is particularly indicated if you have already built a previous version of AAPS on the same computer.

Check in the Building Instructions the required version for JVM, matching the AAPS version you are now building. Then follow the steps described at Incompatible Gradle JVM to make sure you currently use the correct version.

Build the Signed APK

Your sourcecode is now the current released version, and all prerequisites have been checked. It’s time to build the signed apk as described in the build signed apk section.

Transfer and install the apk

You need to transfer the apk to your phone so you can install it.

Note

If you completed the build with the same existing key store in Android Studio, then you do not need to remove the existing app on your phone. When you install the apk, follow the prompts to install updates. For other scenarios such as establishing a new key store in Android Studio for your signed apk, you will need to delete the old app before installing the apk. Make sure to export your settings!

See the instructions for transferring and installing AAPS

Check AAPS version on phone

After you installed the new apk, you can check the AAPS version on your phone by clicking the three dots menu on the top right and then About. You should see the current version.

AAPS version installed

Check in the Release Notes if there are any specific instructions after update.

Troubleshooting

If anything goes wrong, don’t panic.

Take a breath!

Then see the separate page troubleshooting Android Studio if your problem is already documented!

If you need further help, please reach out to other AAPS users on Facebook or Discord.