update and publish docs

Author: Adrian Tosca

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

@@ -1,8 +1,8 @@
 name: Publish
 on:
   workflow_dispatch
-#  release:
-#    types: [created]
+permissions:
+  contents: write
 jobs:
   publish:
     runs-on: ubuntu-latest
@@ -16,6 +16,11 @@ jobs:
       - run: ./gradlew build
       - run: ./gradlew publish
       - run: ./gradlew jreleaserFullRelease
+      - uses: JamesIves/github-pages-deploy-action@releases/v3
+        with:
+          ACCESS_TOKEN: ${{ secrets.JRELEASER_GITHUB_TOKEN }}
+          BRANCH: gh-pages
+          FOLDER: build/dokka/html
     env:
       ENV: "CI"
       JRELEASER_GPG_PUBLIC_KEY: ${{ secrets.JRELEASER_GPG_PUBLIC_KEY }}

README.md

@@ -1,6 +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.7-blue)
+![Current Version](https://img.shields.io/badge/Version-0.0.8-blue)
 
 
 ## A Kotlin implementation of [TypeID](https://github.com/jetpack-io/typeid).
@@ -23,14 +23,14 @@ To use with Maven:
 <dependency>
     <groupId>earth.adi</groupId>
     <artifactId>typeid-kotlin</artifactId>
-    <version>0.0.7</version>
+    <version>0.0.8</version>
 </dependency>
 ```
 
 To use via Gradle:
 
 ```kotlin
-implementation("earth.adi:typeid-kotlin:0.0.7")
+implementation("earth.adi:typeid-kotlin:0.0.8")
 ```
 
 

build.gradle.kts

@@ -14,7 +14,7 @@ plugins {
 
 group = "earth.adi"
 
-version = "0.0.7"
+version = "0.0.8"
 
 repositories { mavenCentral() }
 
@@ -52,10 +52,7 @@ configure<com.diffplug.gradle.spotless.SpotlessExtension> {
   }
 }
 
-task<Exec>("updateReadmeVersion") {
-  //  mustRunAfter(tasks.build)
-  commandLine("sh", "./scripts/updateReadmeVersion.sh")
-}
+task<Exec>("updateReadmeVersion") { commandLine("sh", "./scripts/updateReadmeVersion.sh") }
 
 tasks.test {
   useJUnitPlatform()
@@ -150,7 +147,15 @@ publishing {
   repositories { maven { url = stagingDir.get().asFile.toURI() } }
 }
 
-tasks.publish { dependsOn(tasks.dokkaJekyll) }
+tasks {
+  register<Jar>("dokkaJar") {
+    from(dokkaHtml)
+    dependsOn(dokkaHtml)
+    archiveClassifier.set("javadoc")
+  }
+}
+
+tasks.publish { dependsOn(tasks.dokkaHtml) }
 
 jreleaser {
   project {

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

@@ -0,0 +1,4 @@
+/**
+ * Provides classes for encoding and decoding Type IDs.
+ */
+package earth.adi.typeid.codec;

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

@@ -0,0 +1,4 @@
+/**
+ * Contains the Jackson Type ID module for JSON serialization and deserialization.
+ */
+package earth.adi.typeid.jackson;

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

@@ -1,4 +1,18 @@
 /**
- * TypeID package.
+ * Kotlin implementation of <a href="https://github.com/jetpack-io/typeid">TypeID</a>.
+ * <p>
+ * TypeIDs are a modern, type-safe, globally unique identifier based on the upcoming
+ * UUIDv7 standard. They provide a ton of nice properties that make them a great choice
+ * as the primary identifiers for your data in a database, APIs, and distributed systems.
+ * Read more about TypeIDs in their <a href="https://github.com/jetpack-io/typeid">spec</a>.
+ * </p>
+ * <p>
+ * This library provides a Kotlin implementation of TypeIDs, including the ability to
+ * generate new TypeIDs, parse existing TypeIDs, and convert TypeIDs to and from strings.
+ * </p>
+ * <p>
+ * It uses a type-safe approach to ensure that you can't accidentally mix up TypeIDs for a specific
+ * entity with TypeIDs for another entity.
+ * </p>
  */
 package earth.adi.typeid;

src/main/kotlin/earth/adi/typeid/Id.kt

@@ -49,11 +49,4 @@ data class Id<TEntity>(val typedPrefix: TypedPrefix<out TEntity>, val uuid: UUID
   override fun toString(): String {
     return Codec.encode(typedPrefix.prefix, uuid)
   }
-
-  companion object {
-    /**
-     * The suffix for all id types, used for creating default prefixes from the identifier names.
-     */
-    const val ID_SUFFIX = "Id"
-  }
 }