[#244] Rename CoroutineTemplate to template inside workflows, documentation, ...

Author: toby-thanathip

.github/workflows/review_pull_request.yml

@@ -29,16 +29,16 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-gradle-
 
-      - name: Run Detekt on CoroutineTemplate
-        working-directory: ./CoroutineTemplate
+      - name: Run Detekt on template
+        working-directory: ./template
         run: ./gradlew detekt
 
-      - name: Run Android Lint on CoroutineTemplate
-        working-directory: ./CoroutineTemplate
+      - name: Run Android Lint on template
+        working-directory: ./template
         run: ./gradlew lint
 
-      - name: Run unit tests and Jacoco on CoroutineTemplate
-        working-directory: ./CoroutineTemplate
+      - name: Run unit tests and Jacoco on template
+        working-directory: ./template
         run: ./gradlew jacocoTestReport
 
       - name: Set up Ruby

.github/workflows/run_detekt_and_unit_tests.yml

@@ -27,22 +27,22 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-gradle-
 
-      - name: Run Detekt on CoroutineTemplate
-        working-directory: ./CoroutineTemplate
+      - name: Run Detekt on template
+        working-directory: ./template
         run: ./gradlew detekt
 
-      - name: Archive Detekt reports on CoroutineTemplate
+      - name: Archive Detekt reports on template
         uses: actions/upload-artifact@v2
         with:
-          name: DetektReportsCoroutine
-          path: CoroutineTemplate/build/reports/detekt/
+          name: DetektReportsTemplate
+          path: template/build/reports/detekt/
 
-      - name: Run unit tests and Jacoco on CoroutineTemplate
-        working-directory: ./CoroutineTemplate
+      - name: Run unit tests and Jacoco on template
+        working-directory: ./template
         run: ./gradlew jacocoTestReport
 
-      - name: Archive code coverage reports on CoroutineTemplate
+      - name: Archive code coverage reports on template
         uses: actions/upload-artifact@v2
         with:
-          name: CodeCoverageReportsCoroutine
-          path: CoroutineTemplate/app/build/reports/jacoco/jacocoTestReport/
+          name: CodeCoverageReportsTemplate
+          path: template/app/build/reports/jacoco/jacocoTestReport/

.github/workflows/verify_newproject_script.yml

@@ -38,6 +38,6 @@ jobs:
           sdk install kscript 4.0.3
           echo $PATH >> $GITHUB_PATH
 
-      - name: Verify generating new project from CoroutineTemplate
+      - name: Verify generating new project from template
         working-directory: scripts
         run: kscript new_project.kts package-name=co.myproject.example app-name="My Project"

.gitignore

@@ -1,7 +1,7 @@
 *.iml
 .idea
 .gradle
-/CoroutineTemplate/local.properties
+/template/local.properties
 /RxJavaTemplate[DEPRECATED]/local.properties
 .DS_Store
 build/

CoroutineTemplate/README.md

@@ -1,4 +1,4 @@
-# Android Templates: Coroutine
+# Android Templates
 
 - Our optimized Android templates used in our android projects
 
@@ -48,4 +48,4 @@ Report is located at: `./app/build/reports/jacoco/`
 For `release` builds, we need to provide release keystore and signing properties:
 
 - Put the `release.keystore` file at root `config` folder.
-- Put keystore signing properties in [signing.properties](https://github.com/nimblehq/android-templates/blob/develop/CoroutineTemplate/signing.properties).
+- Put keystore signing properties in [signing.properties](https://github.com/nimblehq/android-templates/blob/develop/template/signing.properties).

CoroutineTemplate/app/build.gradle.kts

@@ -33,7 +33,7 @@ android {
 
     compileSdk = Versions.ANDROID_COMPILE_SDK_VERSION
     defaultConfig {
-        applicationId = "co.nimblehq.coroutine"
+        applicationId = "co.nimblehq.template"
         minSdk = Versions.ANDROID_MIN_SDK_VERSION
         targetSdk = Versions.ANDROID_TARGET_SDK_VERSION
         versionCode = Versions.ANDROID_VERSION_CODE

CoroutineTemplate/buildSrc/src/main/java/plugins/jacoco-report.gradle.kts

@@ -40,8 +40,8 @@ val packagesExcluded = setOf(
     "**/com/bumptech/glide",
     "**/dagger/hilt/internal",
     "**/hilt_aggregated_deps",
-    "**/co/nimblehq/coroutine/databinding/**",
-    "**/co/nimblehq/coroutine/di/**"
+    "**/co/nimblehq/template/databinding/**",
+    "**/co/nimblehq/template/di/**"
 )
 
 val fileFilter = fileGenerated + packagesExcluded

Dangerfile

@@ -29,9 +29,9 @@ Dir[lint_dir].each do |file_name|
   android_lint.lint(inline_mode: true)
 end
 
-# Show Danger test coverage report from Jacoco for CoroutineTemplate
-jacoco_dir = "CoroutineTemplate/**/build/reports/jacoco/jacocoTestReport/jacocoTestReport.xml"
-markdown "## CoroutineTemplate Jacoco report:"
+# Show Danger test coverage report from Jacoco for Template
+jacoco_dir = "template/**/build/reports/jacoco/jacocoTestReport/jacocoTestReport.xml"
+markdown "## Template Jacoco report:"
 Dir[jacoco_dir].each do |file_name|
   # Report coverage of modified files, warn if total project coverage is under 80%
   # or if any modified file's coverage is under 95%

README.md

@@ -9,7 +9,7 @@
 
 ---
 
-Our Android template: **[CoroutineTemplate](https://github.com/nimblehq/android-templates/tree/develop/CoroutineTemplate)**
+Our Android template: **[Template](https://github.com/nimblehq/android-templates/tree/develop/template)**
 
 ## Setup
 
@@ -23,7 +23,7 @@ Our Android template: **[CoroutineTemplate](https://github.com/nimblehq/android-
 
   Example: `kscript new_project.kts package-name=co.myproject.example app-name="My Project"`
 
-4. Update `android_version_code` and `android_version_name` in `CoroutineTemplate/build.gradle`
+4. Update `android_version_code` and `android_version_name` in `template/build.gradle`
 
 ## About
 

scripts/new_project.kts

@@ -8,10 +8,10 @@ object NewProject {
     private const val KEY_PACKAGE_NAME = "package-name"
     private const val MINUS_SEPARATOR = "-"
     private const val SPACE_SEPARATOR = " "
-    private const val TEMPLATE_APP_NAME = "Coroutine Template"
-    private const val TEMPLATE_APPLICATION_CLASS_NAME = "CoroutineTemplateApplication"
-    private const val TEMPLATE_FOLDER_NAME = "CoroutineTemplate"
-    private const val TEMPLATE_PACKAGE_NAME = "co.nimblehq.coroutine"
+    private const val TEMPLATE_APP_NAME = "Template"
+    private const val TEMPLATE_APPLICATION_CLASS_NAME = "TemplateApplication"
+    private const val TEMPLATE_FOLDER_NAME = "template"
+    private const val TEMPLATE_PACKAGE_NAME = "co.nimblehq.template"
 
     private const val PATTERN_APP = "^([A-Z][a-zA-Z0-9\\s]*)|([a-z][a-z0-9-]*)$"
     private const val PATTERN_PACKAGE = "^[a-z]+(\\.[a-z][a-z0-9]*)+$"