readme enhancements (#61)

* add compatibility note

* setup jacoco test coverage

* update gha to push report to codecov

* add badges

* gha fix

* gha fix

* add more badges

* add more badges

* filter out generated serializer from coverage report

* fix codecov issue

Author: wenxi-zeng

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: Android CI
+name: CI
 
 on:
   push:
@@ -27,6 +27,10 @@ jobs:
           ${{ runner.os }}-gradle-core-
     - name: Run Tests
       run: ./gradlew core:test
+    - name: Generate coverage report
+      run: ./gradlew core:codeCoverageReport
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v2
 
   android-test:
 
@@ -47,6 +51,10 @@ jobs:
             ${{ runner.os }}-gradle-android-
       - name: Run Tests
         run: ./gradlew android:test
+      - name: Generate coverage report
+        run: ./gradlew android:codeCoverageReport
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
 
   destination-test:
 
@@ -67,6 +75,10 @@ jobs:
             ${{ runner.os }}-gradle-dest-
       - name: Run Tests
         run: ./gradlew samples:kotlin-android-app-destinations:test
+      - name: Generate coverage report
+        run: ./gradlew samples:kotlin-android-app-destinations:codeCoverageReport
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
 
   security:
 

README.md

@@ -1,14 +1,17 @@
 # Analytics-Kotlin
 [![](https://jitpack.io/v/segmentio/analytics-kotlin.svg)](https://jitpack.io/#segmentio/analytics-kotlin)
+[![](https://github.com/segmentio/analytics-kotlin/actions/workflows/build.yml/badge.svg)](https://github.com/segmentio/analytics-kotlin/actions)
+[![codecov](https://codecov.io/gh/segmentio/analytics-kotlin/branch/master/graph/badge.svg)](https://codecov.io/gh/segmentio/analytics-kotlin)
+[![Known Vulnerabilities](https://snyk.io/test/github/segmentio/analytics-kotlin/badge.svg)](https://snyk.io/test/github/segmentio/analytics-kotlin)
+[![](https://img.shields.io/github/license/segmentio/analytics-kotlin)](https://github.com/segmentio/analytics-kotlin/blob/main/LICENSE)
+
 
 The hassle-free way to add Segment analytics to your kotlin app (Android/JVM). Analytics helps you measure your users, product, and business. It unlocks insights into your app's funnel, core business metrics, and whether you have product-market fit.
 
 NOTE: This project is currently in the Beta phase and is covered by Segment's [First Access & Beta Preview Terms](https://segment.com/legal/first-access-beta-preview/).  We encourage you
 to try out this new library. Please provide feedback via Github issues/PRs, and feel free to submit pull requests.  This library will eventually 
 supplant our `analytics-android` library.
 
-NOTE: If you use pure Java codebase, please refer to [Java Compatibility](JAVA_COMPAT.md) for sample usages.
-
 ## How to get started
 1. **Collect analytics data** from your app(s).
   - The top 200 Segment companies collect data from 5+ source types (web, mobile, server, CRM, etc.).
@@ -51,6 +54,14 @@ You can find usage documentation at [https://segment.com/docs/sources/mobile/kot
 
 Explore more via the [example projects](samples) which showcase analytics instrumentation on different platforms/languages and usage of plugins. These projects contain sample [plugins](samples/kotlin-android-app/src/main/java/com/segment/analytics/next/plugins) and [destination plugins](samples/kotlin-android-app-destinations/src/main/java/com/segment/analytics/destinations/plugins) 
 
+## Compatibility
+
+* If you use pure Java codebase, please refer to [Java Compatibility](JAVA_COMPAT.md) for sample usages.
+* The SDK internally uses a number of Java 8 language API through desugaring (see [Java 8+ API desugaring support](https://developer.android.com/studio/write/java8-support#library-desugaring)). Please make sure your project:
+  * either using Android Gradle plugin 4.0.0 or higher
+  * or requiring a minimum API level of 26.
+
+
 ## Contributing
 
 See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

android/build.gradle

@@ -77,4 +77,5 @@ dependencies {
     testImplementation 'androidx.test:core:1.4.0'
 }
 
-apply from: rootProject.file('gradle/jitpack-android.gradle')
+apply from: rootProject.file('gradle/jitpack-android.gradle')
+apply from: rootProject.file('gradle/codecov.gradle')

build.gradle

@@ -46,4 +46,6 @@ snyk {
 
 task clean(type: Delete) {
     delete rootProject.buildDir
-}
+}
+
+apply from: rootProject.file('gradle/codecov.gradle')

core/build.gradle

@@ -29,4 +29,5 @@ dependencies {
     testImplementation "org.junit.jupiter:junit-jupiter"
 }
 
-apply from: rootProject.file('gradle/jitpack-core.gradle')
+apply from: rootProject.file('gradle/jitpack-core.gradle')
+apply from: rootProject.file('gradle/codecov.gradle')

gradle/codecov.gradle

@@ -0,0 +1,37 @@
+apply plugin: 'jacoco'
+
+jacoco {
+    toolVersion = "0.8.7"
+}
+
+task codeCoverageReport(type: JacocoReport) {
+    def fileFilter = ['**/R.class', '**/R$*.class', '**/BuildConfig.*', '**/Manifest*.*', "**/**/*serializer*.*", "**/**/*Companion*.*" ]
+    def mainSrc = []
+    def debugTrees = []
+    def execData = []
+    if(project.name == rootProject.name) {
+        subprojects.each {
+            mainSrc.add("${it.projectDir}/src/main/java")
+            debugTrees.add(fileTree(dir: "${it.buildDir}/classes", excludes: fileFilter))
+            debugTrees.add(fileTree(dir: "${it.buildDir}/tmp/kotlin-classes/debugUnitTest", excludes: fileFilter))
+            execData.add(fileTree(dir: "${it.buildDir}/jacoco", includes: ["*.exec"]))
+        }
+    }
+    else {
+        mainSrc.add("${project.projectDir}/src/main/java")
+        debugTrees.add(fileTree(dir: "${project.buildDir}/classes", excludes: fileFilter))
+        debugTrees.add(fileTree(dir: "${project.buildDir}/tmp/kotlin-classes/debugUnitTest", excludes: fileFilter))
+        execData.add(fileTree(dir: "${project.buildDir}/jacoco", includes: ["*.exec"]))
+    }
+
+    sourceDirectories.setFrom(files(mainSrc))
+    classDirectories.setFrom(files(debugTrees))
+    executionData.setFrom(execData)
+
+    reports {
+        xml.enabled true
+        xml.destination file("${buildDir}/reports/jacoco/report.xml")
+        html.enabled true
+        csv.enabled false
+    }
+}

samples/kotlin-android-app-destinations/build.gradle

@@ -103,4 +103,6 @@ dependencies {
     // For JSON Object testing
     testImplementation 'org.json:json:20200518'
     testImplementation 'org.skyscreamer:jsonassert:1.5.0'
-}
+}
+
+apply from: rootProject.file('gradle/codecov.gradle')