From d68a8118ba229cb89620b27dd2f332c07a13a5e7 Mon Sep 17 00:00:00 2001 From: Benjamin Mwalimu Date: Wed, 9 Oct 2024 23:19:19 +0300 Subject: [PATCH] Update the Burundi EUSM flavor (#3553) * - Add the EUSM Burundi flavour - Rename the exisiting EUSM flavour * - Update the app naming * - update the flavour naming * - Update the flavor naming - Update the documentation * - Update the flavors section of the documentation to clarify on the naming convention --- android/quest/build.gradle.kts | 8 ++++---- docs/engineering/app/automated-releases.mdx | 9 ++++++--- .../app/configuring/add-application-flavors.mdx | 10 +++++++--- 3 files changed, 17 insertions(+), 10 deletions(-) diff --git a/android/quest/build.gradle.kts b/android/quest/build.gradle.kts index c7ddb49b54..1d22c6e27b 100644 --- a/android/quest/build.gradle.kts +++ b/android/quest/build.gradle.kts @@ -323,15 +323,15 @@ android { create("eusmMg") { dimension = "apps" - applicationIdSuffix = ".eusm-mg" - versionNameSuffix = "-eusm-mg" + applicationIdSuffix = ".eusmMg" + versionNameSuffix = "-eusmMg" manifestPlaceholders["appLabel"] = "EUSM Madagascar" } create("eusmBi") { dimension = "apps" - applicationIdSuffix = ".eusm-bi" - versionNameSuffix = "-eusm-bi" + applicationIdSuffix = ".eusmBi" + versionNameSuffix = "-eusmBi" manifestPlaceholders["appLabel"] = "EUSM Burundi" } diff --git a/docs/engineering/app/automated-releases.mdx b/docs/engineering/app/automated-releases.mdx index 56d9c4b4ec..a86c3d1bb7 100644 --- a/docs/engineering/app/automated-releases.mdx +++ b/docs/engineering/app/automated-releases.mdx @@ -62,12 +62,15 @@ To add a flavor, add an entry to the `productFlavors` map in [`android/opensrp/b ``` create("newFlavor") { dimension = "apps" - applicationIdSuffix = ".new-flavor" - versionNameSuffix = "-new-flavor" + applicationIdSuffix = ".newFlavor" + versionNameSuffix = "-newFlavor" manifestPlaceholders["appLabel"] = "New Flavor App Name" } ``` - Note, flavor names should always be camel cased + +:::tip +Remember to use **[camelCase](https://en.wikipedia.org/wiki/Camel_case)** when adding the **flavor name** e.g `newFlavor`, **`applicationIdSuffix`** e.g `.newFlavor` and **`versionNameSuffix`** e.g `-newFlavor` +::: You can add the following resources: diff --git a/docs/engineering/app/configuring/add-application-flavors.mdx b/docs/engineering/app/configuring/add-application-flavors.mdx index 75264870b3..5a8ba0370d 100644 --- a/docs/engineering/app/configuring/add-application-flavors.mdx +++ b/docs/engineering/app/configuring/add-application-flavors.mdx @@ -35,14 +35,18 @@ productFlavors { The product flavors are easily modigied to the specified app flavor e.g. ``` -create("afyayangu") { +create("afyaYangu") { dimension = "apps" - applicationIdSuffix = ".afyayangu" - versionNameSuffix = "-afyayangu" + applicationIdSuffix = ".afyaYangu" + versionNameSuffix = "-afyaYangu" manifestPlaceholders["appLabel"] = "Afya Yangu" } ``` +:::tip +Remember to use **[camelCase](https://en.wikipedia.org/wiki/Camel_case)** when adding the **flavor name** e.g `newFlavor`, **`applicationIdSuffix`** e.g `.newFlavor` and **`versionNameSuffix`** e.g `-newFlavor` +::: + ### Config properties of productFlavors |Property | Description | Required | Default | |--|--|:--:|:--:|