Merge pull request #17 from PatilShreyas/maven-publish

PatilShreyas · web-flow · commit 1b13fbd8b5ba · 2023-01-21T16:32:38.000+05:30
Setup artifact publishing on maven
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -26,19 +26,40 @@ jobs:
           key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
           restore-keys: |
             ${{ runner.os }}-gradle-
-            
-      - name: Grant Permission to Execute
-        run: chmod +x gradlew
 
-      - name: 🏗 Build with Gradle 🛠️
-        run: ./gradlew build --stacktrace
-        
       - name: Set up NPM
         uses: actions/setup-node@v3
         with:
           node-version: 14
           registry-url: 'https://registry.npmjs.org'
+            
+      - name: Grant Permission to Execute
+        run: chmod +x gradlew
+
+      - name: 🏗 Build with Gradle 🛠️
+        run: ./gradlew build --stacktrace
+
+      - name: Publish Library on Maven Central
+        run: |
+          echo "Publishing Core🚀"
+          ./gradlew :core:publish
+          echo "Published Core✅"
+          echo "Releasing Core...🚀"
+          ./gradlew closeAndReleaseRepository
+          echo "Released Core✅"
           
+          echo "Publishing Report Generator🚀"
+          ./gradlew :reportGenerator:publish
+          echo "Published Report Generator✅"
+          echo "Releasing Report Generator...🚀"
+          ./gradlew closeAndReleaseRepository
+          echo "Released Report Generator✅"
+        env:
+          ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.GPG_KEY }}
+          ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.GPG_PASSWORD }}
+          ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
+          ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
+
       - name: Publish CLI Application 🚀
         run: |
           npm ci
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Compose Compiler Reports to HTML Generator
 
-A CLI utility to convert Jetpack Compose compiler metrics and reports to beautified 😍 HTML page. 
+A CLI utility to convert Jetpack Compose compiler metrics and reports to beautified 😍 HTML page.
 _Made with ❤️ for Android Developers and Composers_
 
 [![Build](https://github.com/PatilShreyas/compose-report-to-html/actions/workflows/build.yml/badge.svg)](https://github.com/PatilShreyas/compose-report-to-html/actions/workflows/build.yml)
@@ -12,23 +12,26 @@ _Made with ❤️ for Android Developers and Composers_
 [![GitHub watchers](https://img.shields.io/github/watchers/PatilShreyas/compose-report-to-html?style=social)](https://github.com/PatilShreyas/compose-report-to-html/watchers)
 [![Twitter Follow](https://img.shields.io/twitter/follow/imShreyasPatil?label=Follow&style=social)](https://twitter.com/imShreyasPatil)
 
+|           | **Install**                                                                                                                                                                                                                                                               | **Downloads**                                                                                                                                                                                                                              |
+|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **NPM**   | [![NPM Package](https://img.shields.io/npm/v/compose-report2html?label=npm&logo=npm)](https://www.npmjs.com/package/compose-report2html)                                                                                                                                  | [![NPM Downloads](https://img.shields.io/npm/dm/compose-report2html?label=Downloads&logo=npm)](https://www.npmjs.com/package/compose-report2html)                                                                                          |
+| **JAR**   | [![Download JAR](https://img.shields.io/github/v/release/patilshreyas/compose-report-to-html?label=JAR&logo=java)](https://github.com/patilshreyas/compose-report-to-html/releases/latest/download/composeReport2Html.jar)                                                | [![GitHub downloads](https://img.shields.io/github/downloads/PatilShreyas/compose-report-to-html/total?label=Downloads&logo=java)](https://github.com/patilshreyas/compose-report-to-html/releases/latest/download/composeReport2Html.jar) |
+| **Maven** | [![Install](https://img.shields.io/maven-central/v/dev.shreyaspatil.compose-compiler-report-generator/core?label=Maven%20Central&logo=android&style=flat-square)](https://search.maven.org/search?q=g:dev.shreyaspatil.compose-compiler-report-generator) |
 
-|         | **Install**                                                                                                                                                                                                                             | **Downloads**                                                                                                                                                                                                                              |
-|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **NPM** | [![NPM Package](https://img.shields.io/npm/v/compose-report2html?label=npm&logo=npm)](https://www.npmjs.com/package/compose-report2html)                                                                                                | [![NPM Downloads](https://img.shields.io/npm/dm/compose-report2html?label=Downloads&logo=npm)](https://www.npmjs.com/package/compose-report2html)                                                                                    |
-| **JAR** | [![Download JAR](https://img.shields.io/github/v/release/patilshreyas/compose-report-to-html?label=JAR&logo=java)](https://github.com/patilshreyas/compose-report-to-html/releases/latest/download/composeReport2Html.jar) | [![GitHub downloads](https://img.shields.io/github/downloads/PatilShreyas/compose-report-to-html/total?label=Downloads&logo=java)](https://github.com/patilshreyas/compose-report-to-html/releases/latest/download/composeReport2Html.jar) |
+## 💡 Motivation
 
-
-## 💡 Motivation 
-
-The Compose Compiler plugin can generate reports / metrics around certain compose-specific concepts that can be useful to understand what is happening with some of your compose code at a fine-grained level.
-[_**See this**_](https://github.com/androidx/androidx/blob/androidx-main/compose/compiler/design/compiler-metrics.md).  
+The Compose Compiler plugin can generate reports / metrics around certain compose-specific concepts that can be useful
+to understand what is happening with some of your compose code at a fine-grained level.
+[_**See this**_](https://github.com/androidx/androidx/blob/androidx-main/compose/compiler/design/compiler-metrics.md).
 
 This generates reports in `json`, `csv` and `txt` files which are not easily trace-able for developers.
 Also, Composable function and class reports becomes large and tedious to check.
-This tool parses the reports and metrics generated by Compose compiler and beautifies into a HTML page and intelligently distinguishes problematic and non-problematic composable functions and classes.
+This tool parses the reports and metrics generated by Compose compiler and beautifies into a HTML page and intelligently
+distinguishes problematic and non-problematic composable functions and classes.
 
-_This utility doesn't generate Compose Metrics and Reports. First, raw Compose report should be generated from the Compiler and those generated files should be feed to this utility. By parsing that data, this utility generates the beautified report._
+_This utility doesn't generate Compose Metrics and Reports. First, raw Compose report should be generated from the
+Compiler and those generated files should be feed to this utility. By parsing that data, this utility generates the
+beautified report._
 
 ## 🧑‍💻 Usage
 
@@ -40,7 +43,8 @@ To install the CLI utility, there are two ways
 
 #### 1.1 Directly use `.jar` distribution
 
-Navigate to the [releases](https://github.com/PatilShreyas/compose-report-to-html/releases) and download the latest JAR artifact.
+Navigate to the [releases](https://github.com/PatilShreyas/compose-report-to-html/releases) and download the latest JAR
+artifact.
 
 #### 1.2 Install from NPM
 
@@ -84,7 +88,10 @@ Options:
 
 ### 3. Generate report
 
-Make sure to generate Compose compiler metrics and reports as mentioned [here](https://github.com/androidx/androidx/blob/androidx-main/compose/compiler/design/compiler-metrics.md) or [this good read article by Chris Banes](https://chris.banes.dev/composable-metrics/). These files are then needed to this CLI utility to feed the data.
+Make sure to generate Compose compiler metrics and reports as
+mentioned [here](https://github.com/androidx/androidx/blob/androidx-main/compose/compiler/design/compiler-metrics.md)
+or [this good read article by Chris Banes](https://chris.banes.dev/composable-metrics/). These files are then needed to
+this CLI utility to feed the data.
 
 To generate the report, provide details related to app, metric and report files and output directory.
 
@@ -112,9 +119,17 @@ java -jar composeReport2Html.jar \
   -o notyReport
 ```
 
-In the above example, it will create report with name **"NotyKT"** with specified metric and report files and finally report will be generated in the specified path i.e. `notyReport/index.html`.
+In the above example, it will create report with name **"NotyKT"** with specified metric and report files and finally
+report will be generated in the specified path i.e. `notyReport/index.html`.
+
+## Utility as a library
+
+This utility is also published as a maven artifact on Maven Central so that you can make use of it as you want to use it
+(_For example: automation in CI_).
+
+Refer to the Wiki for more information: [**Using this utility as a library**](https://github.com/PatilShreyas/compose-report-to-html/wiki/Using-utility-as-a-library)
 
-## 📈 Report Overview 
+## 📈 Report Overview
 
 Once report is generated, it looks like this.
 
@@ -126,7 +141,7 @@ Once report is generated, it looks like this.
 | **Class Report**        | Parses `-classes.txt` file and separates out stable and unstable classes out of it and properly highlights issues associated with them. <br><br> ![Class Report](images/class-report.png)             |
 
 Right now, work is in progress and more improvements related to the report
-will happen in some time. If you have any feedback / suggestions related to 
+will happen in some time. If you have any feedback / suggestions related to
 the report, feel free to discuss it (_find discussion link in the below section_).
 
 ## 🙋‍♂️ Contribute
@@ -135,7 +150,8 @@ Read [contribution guidelines](CONTRIBUTING.md) for more information regarding c
 
 ## 💬 Discuss?
 
-Have any questions, doubts or want to present your opinions, views? You're always welcome. You can [start discussions](https://github.com/PatilShreyas/compose-report-to-html/discussions).
+Have any questions, doubts or want to present your opinions, views? You're always welcome. You
+can [start discussions](https://github.com/PatilShreyas/compose-report-to-html/discussions).
 
 ## License
 
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,15 +1,16 @@
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
-val libraryVersion: String by project
-val libraryGroup: String by project
+val VERSION_NAME: String by project
+val GROUP: String by project
 
 plugins {
-    kotlin("jvm") version "1.7.20"
+    kotlin("jvm") version libs.versions.kotlin.get()
     alias(libs.plugins.spotless)
+    alias(libs.plugins.mavenPublish) apply false
 }
 
-group = libraryGroup
-version = libraryVersion
+group = GROUP
+version = VERSION_NAME
 
 repositories {
     mavenCentral()
diff --git a/cli/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/cli/Main.kt b/cli/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/cli/Main.kt
@@ -161,5 +161,5 @@ fun printHeader(header: String) = println(
 )
 
 object Constants {
-    const val VERSION = "v1.0.0-alpha01"
+    const val VERSION = "v1.0.0-alpha02"
 }
diff --git a/core/build.gradle.kts b/core/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     kotlin("jvm")
+    id(libs.plugins.mavenPublish.get().pluginId)
 }
 
 repositories {
diff --git a/core/gradle.properties b/core/gradle.properties
@@ -0,0 +1,3 @@
+POM_ARTIFACT_ID=core
+POM_NAME=Compose Report to HTML - Core
+POM_DESCRIPTION=Generates details from raw compose report. 
diff --git a/gradle.properties b/gradle.properties
@@ -1,4 +1,23 @@
 kotlin.code.style=official
 
-libraryGroup=dev.shreyaspatil.compose-compiler-report-generator
-libraryVersion=1.0.0-alpha01
+GROUP=dev.shreyaspatil.compose-compiler-report-generator
+VERSION_NAME=1.0.0-alpha02
+
+# Library configuration
+SONATYPE_HOST=DEFAULT
+RELEASE_SIGNING_ENABLED=true
+
+POM_INCEPTION_YEAR=2023
+POM_URL=https://github.com/PatilShreyas/compose-report-to-html/
+
+POM_LICENSE_NAME=MIT
+POM_LICENSE_URL=https://raw.githubusercontent.com/PatilShreyas/compose-report-to-html/main/LICENSE
+POM_LICENSE_DIST=repo
+
+POM_SCM_URL=https://github.com/PatilShreyas/compose-report-to-html/
+POM_SCM_CONNECTION=scm:git:git://github.com/PatilShreyas/compose-report-to-html.git
+POM_SCM_DEV_CONNECTION=scm:git:ssh://git@github.com/PatilShreyas/compose-report-to-html.git
+
+POM_DEVELOPER_ID=PatilShreyas
+POM_DEVELOPER_NAME=Shreyas Patil
+POM_DEVELOPER_URL=https://github.com/PatilShreyas/
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -1,9 +1,11 @@
 [versions]
-coroutines = "1.6.1"
+kotlin = "1.8.0"
+coroutines = "1.6.4"
 moshi = "1.13.0"
 spotless = "6.3.0"
 kotlinxHtml = "0.7.5"
 kotlinxCli = "0.3.4"
+mavenPublish = "0.23.2"
 
 [libraries]
 moshi = { module = "com.squareup.moshi:moshi-kotlin", version.ref = "moshi" }
@@ -12,4 +14,5 @@ kotlinx-html-jvm = { module = "org.jetbrains.kotlinx:kotlinx-html-jvm", version.
 kotlinx-cli = { module = "org.jetbrains.kotlinx:kotlinx-cli", version.ref = "kotlinxCli" }
 
 [plugins]
-spotless = { id = "com.diffplug.spotless", version.ref = "spotless" }
+spotless = { id = "com.diffplug.spotless", version.ref = "spotless" }
+mavenPublish = { id = "com.vanniktech.maven.publish", version.ref = "mavenPublish" }
diff --git a/package.json b/package.json
@@ -7,7 +7,7 @@
   "main": "index.js",
   "preferGlobal": true,
   "repository": "https://github.com/PatilShreyas/compose-report-to-html",
-  "version": "1.0.0-alpha01",
+  "version": "1.0.0-alpha02",
   "jdeploy": {
     "jdk": false,
     "javaVersion": "11",
diff --git a/reportGenerator/build.gradle.kts b/reportGenerator/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     kotlin("jvm")
+    id(libs.plugins.mavenPublish.get().pluginId)
 }
 repositories {
     mavenCentral()
diff --git a/reportGenerator/gradle.properties b/reportGenerator/gradle.properties
@@ -0,0 +1,3 @@
+POM_ARTIFACT_ID=report-generator
+POM_NAME=Compose Report to HTML - Report generator
+POM_DESCRIPTION=Generates HTML report from raw Compose report.

Original file line number	Diff line number	Diff line change
`@@ -161,5 +161,5 @@ fun printHeader(header: String) = println(`
`161`	`161`	`)`
`162`	`162`
`163`	`163`	`object Constants {`
`164`		`- const val VERSION = "v1.0.0-alpha01"`
	`164`	`+ const val VERSION = "v1.0.0-alpha02"`
`165`	`165`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`plugins {`
`2`	`2`	`kotlin("jvm")`
	`3`	`+ id(libs.plugins.mavenPublish.get().pluginId)`
`3`	`4`	`}`
`4`	`5`
`5`	`6`	`repositories {`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+POM_ARTIFACT_ID=core`
	`2`	`+POM_NAME=Compose Report to HTML - Core`
	`3`	`+POM_DESCRIPTION=Generates details from raw compose report.`