Quafka service pack 1

Author: oguzhaneren

.editorconfig

@@ -17,14 +17,18 @@ max_line_length = 140
 [{*.kt,*.kts}]
 #indent_style = space
 max_line_length = 140
-#indent_size = 2
+ktlint_standard_import-ordering = enabled
+ktlint_standard_no-unused-imports = enabled
+ij_java_delete_unused_module_imports = true
+ktlint_code_style = intellij_idea
 ij_kotlin_code_style_defaults = KOTLIN_OFFICIAL
 #ij_continuation_indent_size = 2
 ij_kotlin_allow_trailing_comma = false
 ij_kotlin_allow_trailing_comma_on_call_site = false
 ij_kotlin_name_count_to_use_star_import = 2
 ij_kotlin_name_count_to_use_star_import_for_members = 2
 
+
 [{**/test/**.kt,**/test-e2e/**.kt,**/test-int/**.kt}]
 max_line_length = 240
 ktlint_standard_no-consecutive-comments = disabled

.github/workflows/dokka-gh-pages.properties.json

@@ -0,0 +1,10 @@
+{
+    "name": "Dokka GitHub Pages deployment",
+    "description": "A workflow template to deploy the API documentation to GitHub Pages with Dokka. Please update the branches, runners, and the JDK versions and distributions according to your specific needs.",
+    "categories": [
+        "Dokka",
+        "Kotlin",
+        "Kotlin Multiplatform",
+        "Gradle"
+    ]
+}

.github/workflows/dokka-gh-pages.yml

@@ -0,0 +1,61 @@
+name: Deploy the API documentation to GitHub Pages with Dokka
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: macos-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v5
+        with:
+          java-version: "17"
+          distribution: "temurin"
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: Build the distribution with Gradle Wrapper
+        run: ./gradlew :dokkaGeneratePublicationHtml
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: _dokka/
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -85,5 +85,5 @@ kotlin-ide/
 build
 .kotlin
 lib/**/reports
-
+_dokka
 # Temp

README.md

@@ -1,4 +1,5 @@
-import org.gradle.kotlin.dsl.libs
+import com.vanniktech.maven.publish.JavadocJar
+import com.vanniktech.maven.publish.KotlinJvm
 import org.gradle.plugins.ide.idea.model.IdeaModel
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 
@@ -8,6 +9,8 @@ plugins {
     alias(libs.plugins.testLogger)
     alias(libs.plugins.kover)
     alias(libs.plugins.maven.publish)
+    alias(libs.plugins.dokka)
+    alias(libs.plugins.javadoc)
     idea
     java
 }
@@ -26,10 +29,11 @@ kover {
     }
 }
 
-val koverProjects = subprojects.of("lib")
+val publishedProjects = subprojects.of("lib")
 dependencies {
-    koverProjects.forEach {
+    publishedProjects.forEach {
         kover(it)
+        dokka(it)
     }
 }
 
@@ -116,17 +120,33 @@ subprojects.of("lib", "examples") {
     }
 }
 
-val publishedProjects = listOf(
-    "quafka",
-    "quafka-extensions"
-)
-
-subprojects.of("lib", filter = { p -> publishedProjects.contains(p.name) }) {
+publishedProjects.forEvery {
     val p = this
-    println("publishing $name")
+
     apply {
         plugin("java")
         plugin(rootProject.libs.plugins.maven.publish.pluginId)
+        plugin(rootProject.libs.plugins.dokka.pluginId)
+        plugin(rootProject.libs.plugins.javadoc.pluginId)
+    }
+
+    dokka {
+        dokkaPublications.html {
+            suppressInheritedMembers.set(true)
+            failOnWarning.set(false)
+        }
+        dokkaSourceSets.main {
+            skipDeprecated = false
+            sourceLink {
+                localDirectory = project.projectDir
+                remoteUrl("https://github.com/Trendyol/quafka/tree/master/lib/${p.name}/src")
+                remoteLineSuffix.set("#L")
+            }
+            samples.from("examples")
+        }
+        pluginsConfiguration.html {
+            footerMessage.set("(c) Trendyol")
+        }
     }
 
     configure<JavaPluginExtension> {
@@ -147,6 +167,12 @@ subprojects.of("lib", filter = { p -> publishedProjects.contains(p.name) }) {
     }
 
     mavenPublishing {
+        configure(
+            KotlinJvm(
+                javadocJar = JavadocJar.Dokka("dokkaHtmlJar"),
+                sourcesJar = true
+            )
+        )
         publishToMavenCentral()
         coordinates(groupId = rootProject.group.toString(), artifactId = project.name, version = rootProject.version.toString())
 
@@ -177,3 +203,24 @@ subprojects.of("lib", filter = { p -> publishedProjects.contains(p.name) }) {
         }
     }
 }
+
+dokka {
+    dokkaPublications.html {
+        outputDirectory.set(rootDir.resolve("_dokka"))
+
+        pluginsConfiguration.html {
+            customAssets.from("docs/assets/logo.jpeg")
+            footerMessage.set("(c) Trendyol")
+        }
+        includes.from(
+            project.layout.projectDirectory.file("README.md"),
+            project.layout.projectDirectory.dir("docs/fundamentals.md")
+        )
+    }
+}
+
+val dokkaHtmlJar by tasks.registering(Jar::class) {
+    description = "A HTML Documentation JAR containing Dokka HTML"
+    from(tasks.dokkaGeneratePublicationHtml.flatMap { it.outputDirectory })
+    archiveClassifier.set("html-doc")
+}

build.gradle.kts

@@ -30,6 +30,10 @@ fun Collection<Project>.of(
     action: Action<Project>
 ): Unit = this.filter { parentProjects.contains(it.parent?.name) && filter(it) }.forEach { action(it) }
 
+fun Collection<Project>.forEvery(
+    action: Action<Project>
+): Unit = this.forEach { action(it) }
+
 val runningOnCI: Boolean
     get() = System.getenv("CI") != null ||
         System.getenv("GITHUB_ACTIONS") != null ||