Merge pull request #36 from LakshanKarunathilake/add-readme

Add readme and codecov report

.github/workflows/build-timestamped-master.yml

@@ -37,4 +37,4 @@ jobs:
         run: |
           ./gradlew publish --scan --no-daemon --stacktrace --console=plain
       - name: Generate CodeCov Report
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v2

.github/workflows/pull-request.yml

@@ -19,9 +19,9 @@ jobs:
           packageUser: ${{ github.actor }}
           packagePAT: ${{ secrets.GITHUB_TOKEN }}
         run: |
-            ./gradlew build  --stacktrace --console=plain
+            ./gradlew build test --stacktrace --console=plain
       - name: Generate Codecov Report
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v2
 
   windows-build:
     name: Build on Windows

README.md

@@ -1,2 +1,91 @@
-# module-ballerina-observe
-Ballerina observability components exposed for users
+
+Ballerina Observe Internal Library
+===================
+
+[![Build](https://github.com/ballerina-platform/module-ballerina-http/actions/workflows/build-timestamped-master.yml/badge.svg)](https://github.com/ballerina-platform/module-ballerinai-observe/actions/workflows/build-timestamped-master.yml)
+[![Trivy](https://github.com/ballerina-platform/module-ballerina-http/actions/workflows/trivy-scan.yml/badge.svg)](https://github.com/ballerina-platform/module-ballerinai-observe/actions/workflows/trivy-scan.yml)
+[![GitHub Last Commit](https://img.shields.io/github/last-commit/ballerina-platform/module-ballerina-http.svg)](https://github.com/ballerina-platform/module-ballerinai-observe/commits/master)
+[![codecov](https://codecov.io/gh/ballerina-platform/module-ballerina-observe/branch/master/graph/badge.svg)](https://codecov.io/gh/ballerina-platform/module-ballerina-observe)
+
+This module contains internal configurations and initializations for Ballerina observability. Ballerina supports observability out of the box. You can use the [module-ballerina-observe](https://github.com/ballerina-platform/module-ballerina-observe) in your Ballerina project and enable observability features.
+
+By default, observability is not included in the executable created by Ballerina. It can be added by using the `--observability-included` build flag or by adding the following section to the `Ballerina.toml` file.
+
+## Build from the source
+
+### Set Up the prerequisites
+
+1. Download and install Java SE Development Kit (JDK) version 11 (from one of the following locations).
+
+    * [Oracle](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html)
+
+    * [OpenJDK](https://adoptopenjdk.net/)
+
+      > **Note:** Set the JAVA_HOME environment variable to the path name of the directory into which you installed JDK.
+
+2. Export your GitHub Personal access token with read package permissions as follows.
+
+        export packageUser=<Username>
+        export packagePAT=<Personal access token>
+
+### Build the source
+
+Execute the commands below to build from source.
+
+1. To build the library:
+    ```
+    ./gradlew clean build
+    ```
+
+2. To run the integration tests:
+    ```
+    ./gradlew clean test
+    ```
+
+3. To run a group of tests
+    ```
+    ./gradlew clean test -Pgroups=<test_group_names>
+    ```
+
+4. To build the package without the tests:
+    ```
+    ./gradlew clean build -x test
+    ```
+
+5. To debug the tests:
+    ```
+    ./gradlew clean test -Pdebug=<port>
+    ```
+
+6. To debug with Ballerina language:
+    ```
+    ./gradlew clean build -PbalJavaDebug=<port>
+    ```
+
+7. Publish the generated artifacts to the local Ballerina central repository:
+    ```
+    ./gradlew clean build -PpublishToLocalCentral=true
+    ```
+
+8. Publish the generated artifacts to the Ballerina central repository:
+    ```
+    ./gradlew clean build -PpublishToCentral=true
+    ```
+
+## Contribute to Ballerina
+
+As an open source project, Ballerina welcomes contributions from the community.
+
+For more information, go to the [contribution guidelines](https://github.com/ballerina-platform/ballerina-lang/blob/master/CONTRIBUTING.md).
+
+## Code of conduct
+
+All contributors are encouraged to read the [Ballerina Code of Conduct](https://ballerina.io/code-of-conduct).
+
+## Useful links
+
+* For more information go to the [`Observe` library](https://lib.ballerina.io/ballerina/observe/latest).
+* For example demonstrations of the usage, go to [Ballerina By Examples](https://ballerina.io/learn/by-example/).
+* Chat live with us via our [Slack channel](https://ballerina.io/community/slack/).
+* Post all technical questions on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag.
+* View the [Ballerina performance test results](https://github.com/ballerina-platform/ballerina-lang/blob/master/performance/benchmarks/summary.md).

ballerina-tests/build.gradle

@@ -55,8 +55,40 @@ task copyObserveStdlib {
     }
 }
 
+def classFilesArray = []
+
+task copyBallerinaClassFiles {
+    doFirst {
+        fileTree("$project.rootDir/ballerina/build/bal_build_target").include("**/*.jar").forEach { jar ->
+            zipTree(jar).matching {
+                exclude '**/tests/*'
+                exclude '**/$_init.class'
+                exclude '**/$value$Caller.class'
+                exclude '**/$value$Detail.class'
+                exclude '**/$value$DetailType.class'
+                exclude '**/$value$EmptyIterator.class'
+                exclude '**/$value$$anonType$_6.class'
+                exclude '**/$value$$anonType$_*.class'
+                exclude '**/$value$_Frame.class'
+                include '**/*.class'
+            }.each { file -> classFilesArray.push(file) }
+        }
+    }
+}
+
+jacocoTestReport {
+    dependsOn test
+    dependsOn copyBallerinaClassFiles
+    additionalClassDirs files(classFilesArray)
+    reports {
+        xml.enabled true
+        html.enabled true
+    }
+}
+
 test {
     dependsOn(copyObserveStdlib)
+    finalizedBy jacocoTestReport
     useTestNG() {
         suites 'src/test/resources/testng.xml'
     }

codecov.yml

@@ -0,0 +1,6 @@
+fixes:
+- "ballerina/observe/*/::ballerina/"
+- "ballerina/observe$0046mockextension/*/::ballerina/modules/mockextension"
+
+ignore:
+  - "**/tests"