publish configuration

Author: Adrian Tosca

.github/workflows/publish-on-release.yml

@@ -14,9 +14,13 @@ jobs:
           java-version: 17
       - uses: gradle/actions/setup-gradle@v3
       - run: ./gradlew build
-      - run: ./gradlew publishAllPublicationsToOSSRHRepository
+      - run: ./gradlew publish
+      - run: ./gradlew jreleaserFullRelease
     env:
-      ORG_GRADLE_PROJECT_OSSRHUsername: ${{ secrets.OSSRH_USERNAME }}
-      ORG_GRADLE_PROJECT_OSSRHPassword: ${{ secrets.OSSRH_TOKEN }}
-      ORG_GRADLE_PROJECT_signingKey: ${{ secrets.GPG_KEY }}
-      ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.GPG_PASSPHRASE }}
+      ENV: "CI"
+      JRELEASER_GPG_PUBLIC_KEY: ${{ secrets.JRELEASER_GPG_PUBLIC_KEY }}
+      JRELEASER_GPG_SECRET_KEY: ${{ secrets.JRELEASER_GPG_SECRET_KEY }}
+      JRELEASER_GPG_PASSPHRASE: ${{ secrets.JRELEASER_GPG_PASSPHRASE }}
+      JRELEASER_MAVENCENTRAL_USERNAME: ${{ secrets.JRELEASER_MAVENCENTRAL_USERNAME }}
+      JRELEASER_MAVENCENTRAL_TOKEN: ${{ secrets.JRELEASER_MAVENCENTRAL_TOKEN }}
+      JRELEASER_GITHUB_TOKEN: ${{ secrets.JRELEASER_GITHUB_TOKEN }}

README.md

@@ -1,5 +1,6 @@
 # typeid-kotlin
 ![Build Status](https://github.com/aleris/typeid-kotlin/actions/workflows/build-on-push.yml/badge.svg)
+![Current Version](https://img.shields.io/badge/Version-0.0.4-blue)
 
 
 ## A Kotlin implementation of [TypeID](https://github.com/jetpack-io/typeid).
@@ -9,7 +10,7 @@ UUIDv7 standard. They provide a ton of nice properties that make them a great ch
 as the primary identifiers for your data in a database, APIs, and distributed systems.
 Read more about TypeIDs in their [spec](https://github.com/jetpack-io/typeid).
 
-Based on the Java implementation from [typeid-java](https://github.com/fxlae/typeid-java).
+Based on the Java implementation from [fxlae/typeid-java](https://github.com/fxlae/typeid-java).
 
 This implementation adds a more complete type safety including id and their prefixes and uses an idiomatic Kotlin API.
 
@@ -22,14 +23,14 @@ To use with Maven:
 <dependency>
     <groupId>earth.adi</groupId>
     <artifactId>typeid-kotlin</artifactId>
-    <version>0.0.1</version>
+    <version>0.0.4</version>
 </dependency>
 ```
 
 To use via Gradle:
 
 ```kotlin
-implementation("earth.adi:typeid-kotlin:0.0.1")
+implementation("earth.adi:typeid-kotlin:0.0.4")
 ```
 
 
@@ -46,7 +47,7 @@ To use the typed features of the library, you need to define your typed id assoc
 
 ```kotlin
 // Define your identifiable entity type:
- data class User(val id: UserId) // can contain other fields
+data class User(val id: UserId) // can contain other fields
 
 // Define a typealias for the user id.
 typealias UserId = Id<out User>
@@ -185,22 +186,43 @@ val read = objectMapper.readValue<JsonUserAndOrganization>(writtenJson)
 ```
 
 
-## Building From Source & Benchmarks
+## Building From Source
  <details>
     <summary>Details</summary>
 
 ```console
 ~$ git clone https://github.com/aleris/typeid-kotlin.git
 ~$ cd typeid-kotling
+~/typeid-kotlin sdk use java 17.0.9-tem
 ~/typeid-kotlin ./gradlew build
 ```
+</details>
+
+
+## Releasing
+ <details>
+    <summary>Details</summary>
+
+```console
+~$ cd typeid-kotling
+~/typeid-kotlin ./gradlew jreleaserConfig
+~/typeid-kotlin ./gradlew clean
+~/typeid-kotlin ./gradlew publish
+~/typeid-kotlin ./gradlew jreleaserFullRelease
+```
+</details>
+
+
+## Benchmarks
+<details>
+    <summary>Details</summary>
 
 There is a small [JMH](https://github.com/openjdk/jmh) microbenchmark included:
 ```console
 ~/typeid-kotlin ./gradlew jmh
 ```
 
-In a single-threaded run, all operations perform in the range of millions of calls per second, 
+In a single-threaded run, all operations perform in the range of millions of calls per second,
 which should be enough for most use cases (used setup: Eclipse Temurin 17 JDK, 2021 MacBook Pro).
 
 | Benchmark                           | Mode  | Cnt |          Score |           Error | Units |

build.gradle.kts

@@ -2,15 +2,19 @@ import org.gradle.api.tasks.testing.logging.TestExceptionFormat.FULL
 import org.gradle.api.tasks.testing.logging.TestLogEvent.*
 
 plugins {
+  `java-library`
   alias(libs.plugins.kotlinJvm)
   alias(libs.plugins.spotless)
   jacoco
   alias(libs.plugins.jmh)
+  `maven-publish`
+  alias(libs.plugins.jreleaser)
+  alias(libs.plugins.dokka)
 }
 
 group = "earth.adi"
 
-version = "0.0.3"
+version = "0.0.4"
 
 repositories { mavenCentral() }
 
@@ -25,7 +29,10 @@ dependencies {
 
 kotlin { jvmToolchain(17) }
 
-java { withSourcesJar() }
+java {
+  withSourcesJar()
+  withJavadocJar()
+}
 
 tasks.withType<JavaCompile> { dependsOn(tasks.spotlessApply) }
 
@@ -45,6 +52,11 @@ configure<com.diffplug.gradle.spotless.SpotlessExtension> {
   }
 }
 
+task<Exec>("updateReadmeVersion") {
+  //  mustRunAfter(tasks.build)
+  commandLine("sh", "./scripts/updateReadmeVersion.sh")
+}
+
 tasks.test {
   useJUnitPlatform()
   finalizedBy(tasks.jacocoTestReport, tasks.jacocoTestCoverageVerification)
@@ -82,7 +94,7 @@ tasks.jacocoTestReport { dependsOn(tasks.test) }
 tasks.jacocoTestCoverageVerification {
   dependsOn(tasks.jacocoTestReport)
 
-  violationRules { rule { limit { minimum = "1".toBigDecimal() } } }
+  violationRules { rule { limit { minimum = "1.00".toBigDecimal() } } }
 }
 
 jmh {
@@ -91,3 +103,81 @@ jmh {
   threads.set(1)
   fork.set(2)
 }
+
+val mavenArtifactId: String by project
+val mavenArtifactDescription: String by project
+
+tasks.jar {
+  manifest {
+    attributes(
+        mapOf(
+            "Implementation-Title" to mavenArtifactId, "Implementation-Version" to project.version))
+  }
+}
+
+val stagingDir: Provider<Directory> = layout.buildDirectory.dir("staging-deploy")
+
+publishing {
+  publications {
+    create<MavenPublication>("mavenJava") {
+      artifactId = mavenArtifactId
+      from(components["java"])
+      pom {
+        name.set(mavenArtifactId)
+        description.set(mavenArtifactDescription)
+        url.set("https://github.com/aleris/typeid-kotlin")
+        licenses {
+          license {
+            name.set("The Apache License, Version 2.0")
+            url.set("http://www.apache.org/licenses/LICENSE-2.0.txt")
+          }
+        }
+        developers {
+          developer {
+            id.set("aleris")
+            name.set("Adrian Tosca")
+            email.set("adrian.tosca@gmail.com")
+          }
+        }
+        scm {
+          connection.set("scm:git:git@github.com:aleris/typeid-kotlin.git")
+          developerConnection.set("scm:git:git@github.com:aleris/typeid-kotlin.git")
+          url.set("https://github.com/aleris/typeid-kotlin/")
+        }
+      }
+    }
+  }
+  repositories { maven { url = stagingDir.get().asFile.toURI() } }
+}
+
+tasks.publish { dependsOn(tasks.dokkaJekyll) }
+
+jreleaser {
+  project {
+    description.set(mavenArtifactDescription)
+    authors.set(arrayListOf("aleris"))
+    license.set("Apache-2.0")
+    inceptionYear = "2024"
+  }
+  release {
+    github {
+      repoOwner.set("aleris")
+      overwrite = true
+    }
+  }
+  signing {
+    active.set(org.jreleaser.model.Active.ALWAYS)
+    armored = true
+  }
+  deploy {
+    maven {
+      mavenCentral {
+        register("sonatype") {
+          active.set(org.jreleaser.model.Active.ALWAYS)
+          url.set("https://central.sonatype.com/api/v1/publisher")
+          stagingRepository(stagingDir.get().toString())
+        }
+      }
+    }
+  }
+}

gradle.properties

@@ -1 +1,3 @@
 kotlin.code.style=official
+mavenArtifactId=typeid-kotlin
+mavenArtifactDescription=A type-safe TypeID implementation for Kotlin

gradle/libs.versions.toml

@@ -7,11 +7,15 @@ junit = "5.10.2"
 assertj = "3.25.3"
 jmh = "0.7.2"
 jqwik = "1.8.4"
+jreleaser = "1.12.0"
+dokka = "1.9.20"
 
 [plugins]
 jmh = { id = "me.champeau.jmh", version.ref = "jmh" }
 kotlinJvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
 spotless = { id = "com.diffplug.spotless", version.ref = "spotless" }
+jreleaser = { id = "org.jreleaser", version.ref = "jreleaser" }
+dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
 
 [libraries]
 javaUuidGenerator = { module = "com.fasterxml.uuid:java-uuid-generator", version.ref = "javaUuidGenerator" }

scripts/updateReadmeVersion.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+
+# Replace the version in README.md with the version from build.gradle.kts
+# Usage:
+#   ./scripts/updateReadmeVersion.sh
+
+SED="sed"
+if ! command -v gsed &> /dev/null
+then
+  # brew install gnu-sed
+  SED="gsed"
+fi
+
+VERSION=$(SED -n 's/^version\s*=\s*"\([0-9]\.[0-9]\.[0-9]\)"/\1/p' < build.gradle.kts)
+
+echo "Updating to version $VERSION in README.md..."
+SED -i -E 's/earth\.adi:typeid-kotlin:[0-9]+\.[0-9]+\.[0-9]+/earth\.adi:typeid-kotlin:'"${VERSION}"'/' README.md
+SED -i -E 's|<version>[0-9]+\.[0-9]+\.[0-9]+|<version>'"${VERSION}"'|' README.md
+SED -i -E 's/Version-[0-9]+\.[0-9]+\.[0-9]+-blue/Version-'"${VERSION}"'-blue/' README.md

src/main/java/earth/adi/package-info.java

@@ -0,0 +1 @@
+package earth.adi;

src/main/java/earth/adi/typeid/JavaType.java

@@ -0,0 +1,20 @@
+package earth.adi.typeid;
+
+/**
+ * JavaType.
+ */
+public class JavaType {
+  public static JavaType of(Class<?> clazz) {
+    return new JavaType(clazz);
+  }
+
+  private final Class<?> clazz;
+
+  private JavaType(Class<?> clazz) {
+    this.clazz = clazz;
+  }
+
+  public Class<?> getClazz() {
+    return clazz;
+  }
+}

src/main/java/earth/adi/typeid/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * TypeID package.
+ */
+package earth.adi.typeid;

src/main/java/earth/package-info.java

@@ -0,0 +1 @@
+package earth;

src/main/kotlin/module-info.java src/main/java/module-info.java

@@ -1,3 +1,6 @@
+/**
+ * TypeId Module.
+ */
 module earth.adi.typeid {
   requires com.fasterxml.uuid;
   requires com.fasterxml.jackson.databind;

src/test/kotlin/earth/adi/typeid/JavaTypeTest.kt

@@ -0,0 +1,18 @@
+package earth.adi.typeid
+
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.jupiter.api.Test
+
+internal class JavaTypeTest {
+  @Test
+  fun of() {
+    val javaType = JavaType.of(String::class.java)
+    assertThat(javaType.clazz).isEqualTo(String::class.java)
+  }
+
+  @Test
+  fun get() {
+    val javaType = JavaType.of(String::class.java)
+    assertThat(javaType.clazz).isEqualTo(String::class.java)
+  }
+}