[#448] [Part2] sample yaml file for codemagic

[lydiasama]

• Add new sample yaml file for setting up CI/CD with CodeMagic #448

What happened 👀

I'll split the task into 2 parts:
Part 1 :

• Initial codemagic.yaml
• Implement unit test step for template-compose and template-xml when opening PR and Push.

Part 2 :

• Set up Firebase Distribution to project
• Iimplement deploy to Firebase Distribution step
• Move the codemagic.yaml file to .codemagic directory
• Add the Readme.md file

Insight 📝

We will have 2 codemagic.yaml files:

1. In the root directory, which contains specific template-compose and template-xml to run the workflow.
2. In the .cicdtemplate, which supports only single project as it will be used when creating the new project.

To access the Codemagic console:

1. Login Github with [email protected]
2. Go to https://codemagic.io/start/ then select signin from Github

No-Goes for template-xml

As we deprecated the template-xml, I didn't implement the deploy script for template-xml to Firebase.

Github Environment Secrets and Variables setup

1. The google-services.json for production and staging are created at the Github environment template-compose :

2. I created the Codemagic Environment backup value to our template's Github environment Codemagic environment:

Codemagic Environment Variables

Created the Codemagic Environment by the following:

Dynamic Version Code

For the dynamic version code, we have 2 alternatives to achieve:

1. Get the Codemagic's environment variable BUILD_NUMBER directly on the build.gragle:

   versionCode = System.getenv("BUILD_NUMBER")?.toInt() ?: Versions.ANDROID_VERSION_CODE

   And in the codemagic.yaml will be the simple build command:

```
./gradlew assembleStagingDebug
```

**Pros**: Easy as it requires just 1 line of code.
**Cons**: It can confuse developers because the `BUILD_NUMBER` property is only from Codemagic, but we have both Codemagic and Github action in our template.

3. Get the version code from versionCode argument from the build command line:

```kotlin
val getVersionCode: () -> Int = {
    if (project.hasProperty("versionCode")) {
        (project.property("versionCode") as String).toInt()
    } else {
        Versions.ANDROID_VERSION_CODE
    }
}
```

And in the codemagic.yaml will be the build command with -PversionCode argument:

```
./gradlew assembleStagingDebug -PversionCode=$BUILD_NUMBER
```

**Pros**: 
- All CD workflow can use the same build command line to build the apk with `-PversionCode`. 
- The usage of `BUILD_NUMBER` will be only inside of `codemagic.yaml` which it belongs to Codemagic's environment variable. So no confusion is created. 👍🏻 

**Cons**: It creates a few more lines on the `build.gradle` file.

💡 Thus, from the pros and cons above, I selected option 2.

📖 The document about build versioning on Codemagic can be found here.

🙏🏻 Special Thanks: @AVI5HEK for helping me review the Codemagic environment setup.

Proof Of Work 📹

Production build:

Staging build:

[github-actions]

	3 Warnings
⚠️	Uh oh! Your project is under 80% coverage!
⚠️	template-compose/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml#L2 - The application adaptive icon is missing a monochrome tag
⚠️	template-compose/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml#L2 - The application adaptive roundIcon is missing a monochrome tag

Kover report for template-xml:

🧛 Template - XML Unit Tests Code Coverage: 34.51%

Coverage of Modified Files:

File	Coverage

Modified Files Not Found In Coverage Report:

README.md
Versions.kt
build.gradle.kts
build.gradle.kts
codemagic.yaml
codemagic.yaml
deploy_staging_and_production_to_firebase_app_distribution.yml
review_pull_request.yml
review_pull_request.yml
run_detekt_and_unit_tests.yml
run_detekt_and_unit_tests.yml

Codebase cunningly covered by count Shroud 🧛

Kover report for template-compose:

🧛 Template - Compose Unit Tests Code Coverage: 62.39%

Coverage of Modified Files:

File	Coverage

Modified Files Not Found In Coverage Report:

README.md
Versions.kt
build.gradle.kts
build.gradle.kts
codemagic.yaml
codemagic.yaml
deploy_staging_and_production_to_firebase_app_distribution.yml
review_pull_request.yml
review_pull_request.yml
run_detekt_and_unit_tests.yml
run_detekt_and_unit_tests.yml

Codebase cunningly covered by count Shroud 🧛

Generated by 🚫 Danger

[luongvo]

The rest looks good 👍

[luongvo]

Some more issues related to what in .cicdtemplate, then it would be good @lydiasama 💪

[lydiasama]

@ryan-conway Let me keep the codemagic.yaml file in the root directory as well so that we can test run at the Codemagic console. 🙏🏻
So we will have 2 codemagic file:

1. In the root directory which contain specific template-compose and template-xml to run the workflow.
2. In the .cicdtemplate which support only single project as it will be used when creating the new project.

[luongvo]

2 files left need to be updated 🏃