Merge pull request #1 from henryhuang1219/develope

Add: Dokka

Author: lazy-assedninja

.github/workflows/ci_android.yml

@@ -1,124 +1,147 @@
-name: CI Android
+name: ci-android
 
 # Controls when the action will run. 
 on:
 
-  # Triggers the workflow on push or pull request events but only for the master branch
+  # Triggers the workflow on push & pull request events but only for the master branch.
   push:
     branches: [ master ]
   pull_request:
     branches: [ master ]
-    
-  # Allows you to run this workflow manually from the Actions tab
+
+  # Allows you to run this workflow manually from the Actions tab.
   workflow_dispatch:
-  
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel.
 jobs:
-  gradle_vaildation:
-    name: Validate Gradle Wrapper
-    
-    # The type of runner that the job will run on
+
+  gradle_validation:
+
+    name: validate-gradle-wrapper
+
+    # The type of runner that the job will run on.
     runs-on: ubuntu-latest
-    
+
     steps:
-    
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - name: Checkout
-        uses: actions/checkout@v2
-        
-      - name: Validate Gradle Wrapper
+
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your workflow can access it.
+      - name: checkout
+        uses: actions/checkout@v3
+
+      # Validates the checksums of Gradle Wrapper JAR files present in the source tree.
+      - name: validate-gradle-wrapper
         uses: gradle/wrapper-validation-action@v1
-      
-  apk:
-    name: Generate APK
-    
+
+  generate_apk:
+
+    name: generate-apk
+
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
-    
+
     # Identifies "gradle_validation" jobs that must complete successfully before this job will run.
-    needs: gradle_vaildation
-    
+    needs: gradle_validation
+
     steps:
-    
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - name: Checkout
-        uses: actions/checkout@v2
-        
-      - name: Assemble Debug APK
+
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your workflow can access it.
+      - name: checkout
+        uses: actions/checkout@v3
+
+      - name: generate-google-services-json
+        env:
+          FIREBASE_PROJECT_INFO: ${{ secrets.FIREBASE_PROJECT_INFO }}
+        run: echo "$FIREBASE_PROJECT_INFO" | base64 --decode >> app/google-services.json
+
+      - name: assemble-debug-apk
         run: ./gradlew assembleDebug --full-stacktrace
-        
-      - name: Upload Debug APK
-        uses: actions/upload-artifact@v2
+
+      # Allowing you to share data between jobs and store data.
+      - name: upload-debug-apk
+        uses: actions/upload-artifact@v3
         with:
           name: app-debug
           path: app/build/outputs/apk/debug/app-debug.apk
-        
-      - name: Assemble Android Test APK
+
+      - name: assemble-android-test-apk
         run: ./gradlew assembleDebugAndroidTest --full-stacktrace
-        
-      - name: Upload Android Test APK
-        uses: actions/upload-artifact@v2
+
+      # Allowing you to share data between jobs and store data.
+      - name: upload-android-test-apk
+        uses: actions/upload-artifact@v3
         with:
           name: app-debug-androidTest
           path: app/build/outputs/apk/androidTest/debug/app-debug-androidTest.apk
-        
+
   unit_tests:
-    name: Unit Tests
-    
+
+    name: unit-tests
+
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
-    
+
     # Identifies "gradle_validation" jobs that must complete successfully before this job will run.
-    needs: gradle_vaildation
-    
+    needs: gradle_validation
+
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
-    
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - name: Checkout
-        uses: actions/checkout@v2
-        
-      - name: Run Unit Tests
+
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your workflow can access it.
+      - name: checkout
+        uses: actions/checkout@v3
+
+      - name: generate-google-services-json
+        env:
+          FIREBASE_PROJECT_INFO: ${{ secrets.FIREBASE_PROJECT_INFO }}
+        run: echo "$FIREBASE_PROJECT_INFO" | base64 --decode >> app/google-services.json && cd app && ls
+
+      - name: run-unit-tests
         run: ./gradlew test --full-stacktrace
-        
+
   Instrumented_unit_tests:
-    name: Instrumented Unit Tests With Firebase Test Lab
-    
+
+    name: instrumented-unit-tests-with-firebase-test-lab
+
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
 
     # Add "id-token" with the intended permissions.
     permissions:
       contents: 'read'
       id-token: 'write'
-    
-    # Identifies "apk" jobs that must complete successfully before this job will run.
-    needs: apk
-    
+
+    # Identifies "generate_apk" jobs that must complete successfully before this job will run.
+    needs: generate_apk
+
     steps:
-    
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - name: Checkout
-        uses: actions/checkout@v2
-        
-      - name: Download APK
-        uses: actions/download-artifact@v2
+
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your workflow can access it.
+      - name: checkout
+        uses: actions/checkout@v3
+
+      # This downloads artifacts from your build.
+      - name: download-apk
+        uses: actions/download-artifact@v3
         with:
           name: app-debug
-          
-      - name: Download Android Test APK
-        uses: actions/download-artifact@v2
+
+      # This downloads artifacts from your build.
+      - name: download-android-test-apk
+        uses: actions/download-artifact@v3
         with:
           name: app-debug-androidTest
 
-      - name: Set up Auth
+      # Establishes authentication to Google Cloud.
+      - name: set-up-auth
         uses: google-github-actions/auth@v0
         with:
           workload_identity_provider: ${{ secrets.GCP_WIP }}
           service_account: ${{ secrets.GCP_SERVICE_ACCOUNT}}
 
-      - name: Set up Cloud SDK
+      # Configures the Google Cloud SDK.
+      - name: set-up-cloud-sdk
         uses: google-github-actions/setup-gcloud@v0
-        
-      - name: Run Instrumented Unit Tests In Firebase Test Lab
+
+      - name: run-instrumented-unit-tests-in-firebase-test-lab
         run: gcloud firebase test android run --type instrumentation --app app-debug.apk --test app-debug-androidTest.apk --device model=Pixel2,version=30

.gitignore

@@ -9,11 +9,15 @@ build/
 .gradle/
 
 # Local configuration file (sdk path, etc, serect keys)
+google-services.json
 local.properties
 
 # Keystore files
 keystore/
 
+# Generate .apk or .aab
+release/
+
 # Proguard reports
 dead_code.txt
 full-r8-config.txt

README.md

@@ -6,20 +6,20 @@ Example of Android packages & frameworks.
 * MacOS 11.4
 * Android Studio Arctic Fox | 2020.3.1 Patch 2
 * Android Gradle Plugin 7.0.2
-* Gradle 7.0.2
+* Gradle 7.2
 * JDK 11.0.13
+  
 
-
-## Language
-* Kotlin
+### Language
+* Kotlin 1.6.10
 
 
 ## Architecture
 * MVVM
 * Clean Architecture
 
 
-## Featuring
+## Features
 * Multi Module
 * Navigation 
 * Composite Build
@@ -32,6 +32,7 @@ Example of Android packages & frameworks.
 * Kotlin Parcelize
 * Kotlin AllOpen
 * Navigation SafeArgs
+* Crashlytics
 * Gradle Build
 * Lint
 
@@ -55,4 +56,4 @@ Example of Android packages & frameworks.
 
 ## Reports
 * [Build Scan](https://scans.gradle.com/s/56hqvvvlvd2ja)
-* [Lint](https://htmlpreview.github.io/?https://github.com/henryhuang1219/Android-Demo/blob/master/app/reports/lint-results-debug.html)
+* [Lint](https://htmlpreview.github.io/?https://github.com/henryhuang1219/Android-Demo/blob/develope/reports/lint/lint-results-debug.html)

app/build.gradle

@@ -2,11 +2,14 @@ import me.lazy_assedninja.plugins.*
 
 plugins {
     id 'com.android.application'
+    id 'com.google.gms.google-services'
+    id 'com.google.firebase.crashlytics'
     id 'kotlin-android'
     id 'kotlin-kapt'
     id 'kotlin-parcelize'
     id 'kotlin-allopen'
     id 'androidx.navigation.safeargs'
+    id 'org.jetbrains.dokka'
 }
 
 allOpen {
@@ -77,8 +80,8 @@ android {
     lintOptions {
         abortOnError false
         checkAllWarnings true
-        disable 'InvalidPackage', 'MediaCapabilities', 'DuplicateStrings', 'LogConditional', 'ConvertToWebp'
-        htmlOutput file("reports/lint-results-debug.html")
+        disable 'InvalidPackage', 'MediaCapabilities', 'ConvertToWebp'
+        htmlOutput file("../reports/lint/lint-results-debug.html")
     }
 
     testOptions {
@@ -94,7 +97,7 @@ android {
     }
 
     jacoco {
-        version = "0.8.7"
+        version = "0.8.8"
     }
 }
 
@@ -112,13 +115,19 @@ dependencies {
     // Lifecycle
     implementation AndroidX.LIFECYCLE_LIVEDATA
     implementation AndroidX.LIFECYCLE_VIEWMODEL
+    implementation AndroidX.LIFECYCLE_RUNTIME
     kapt AndroidX.LIFECYCLE_COMPILER
     implementation AndroidX.LIFECYCLE_EXTENSIONS
 
     // Navigation
     implementation AndroidX.NAVIGATION_FRAGMENT_KTX
     implementation AndroidX.NAVIGATION_UI_KTX
 
+    // Firebase
+    implementation platform(Google.FIREBASE)
+    implementation Google.FIREBASE_CRASHLYTICS
+    implementation Google.FIREBASE_ANALYTICS
+
     // Dagger
     implementation Google.DAGGER
     kapt Google.DAGGER_COMPILER
@@ -151,6 +160,7 @@ dependencies {
     testImplementation AndroidX.CORE_TESTING
     testImplementation ThirdParty.JUNIT
     androidTestImplementation AndroidX.CORE_TESTING
+    debugImplementation AndroidX.TEST_JUNIT
     androidTestImplementation AndroidX.TEST_JUNIT
     androidTestImplementation AndroidX.TEST_ESPRESSO
 

app/proguard-rules.pro

@@ -97,13 +97,13 @@
 
 
 # To output a full report of all the rules that R8 applies.
--printconfiguration full-r8-config.txt
+-printconfiguration ../reports/proguard/full-r8-config.txt
 
 # Exhaustively list classes and class members matched by the various -keep options
--printseeds seeds.txt
+-printseeds ../reports/proguard/seeds.txt
 
 # List dead code of the input class files.
--printusage dead_code.txt
+-printusage ../reports/proguard/dead_code.txt
 
 # Print the mapping from old names to new names for classes and class members that have been renamed.
--printmapping mapping.txt
+-printmapping ../reports/proguard/mapping.txt

app/src/debug/AndroidManifest.xml

@@ -2,7 +2,6 @@
     package="me.lazy_assedninja.demo">
 
     <application
-        android:allowBackup="false"
         android:icon="@mipmap/icon">
 
         <activity android:name=".testing.SingleFragmentActivity" />

app/src/main/AndroidManifest.xml

@@ -1,18 +1,20 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools"
     package="me.lazy_assedninja.demo">
 
     <uses-permission android:name="android.permission.INTERNET" />
 
     <application
         android:name="me.lazy_assedninja.demo.application.DemoApplication"
-        android:allowBackup="false"
-        android:fullBackupContent="false"
+        android:dataExtractionRules="@xml/backup_rules"
+        android:fullBackupContent="@xml/backup_rules"
         android:icon="@mipmap/icon"
         android:label="@string/app_name"
         android:roundIcon="@mipmap/icon_round"
         android:supportsRtl="true"
-        android:theme="@style/Theme.Demo">
+        android:theme="@style/Theme.Demo"
+        tools:targetApi="s">
 
         <activity
             android:name="me.lazy_assedninja.demo.ui.splash.SplashScreenActivity"